ds-caselaw-public-ui | Public frontend to the National Archives Find Case Law | Application Framework library

NOTE: For any of the following commands to work, you must first install Fabric. Once installed, you can type fab -l to see a list of available commands.
At this point you can run the following command to "quick start" the application:.
Starting all of the necessary Docker containers
Installing any new python dependencies
Applying any new database migrations
Starting the Django development server
Any commit that's merged to main needs to be signed, to ensure the identity of the author is who they say they are.
Add your SSH key as a signing key in your github account - note this is different to an authentication key, which you likely already have set up. You can use the same key for both purposes, but you need to add it separately for each one twice.
In your terminal, run the following commands. This assumes you want to set up commit signing by default for all repositories. If you don't want this for whatever, reason, leave out the --global flag (but in that case you'll have to remember to repeat these steps in every TNA repository you work on): Enable signing with git config --global commit.gpgsign true Specify that we'll use SSH for signing with: git config --global gpg.format ssh Specify the key you'll use to sign. If it's not id_rsa.pub, give the correct path here: git config --global user.signingkey ~/.ssh/id_rsa.pub
Remember to git pull the freshest files
If fab build fails early, check that Docker is running? (Click the blue whale)
If the public-ui takes forever to load, check that the VPN is running -- you might need to change the IP address if DNS isn't working for you.
If it was working, and you git pulled, and now it isn't, re-run fab build.
If it's saying environment variables aren't set (especially after a git pull), you might need to add lines to .env -- take them from .env.example