Etna

Project documentation

This project contains technical documentation written in Markdown in the /docs folder. The latest build (from the develop branch) can be viewed online at: https://nationalarchives.github.io/ds-wagtail/

You can also view it locally on http://localhost:8001/ which is booted as the docs container.

Setting up a local build

Local development is done in Docker. You can find out more about this here.

Convenience commands have been added to fabfile.py to help you interact with the various services. But, for any of these commands to work, you must first install Fabric.

Once installed, you can type fab -l to see a list of available commands.

Before starting a build for the first time

cp .env.example .env

1. Build and start Docker containers

fab start

This command takes care of the following:

1. Building all of the necessary Docker containers
2. Starting all of the necessary Docker containers
3. Installing any new python dependencies
4. Collect static assets

2. Start the development server

# Enter the shell for the web container
fab sh

# Run migrations
poetry run python manage.py migrate

# Run the development server
poetry run python manage.py runserver 0.0.0.0:8000

2. Access the site

http://127.0.0.1:8000

3. Create a Django user for yourself

# ...from within the web container
python manage.py createsuperuser

# ...or on the host machine
fab create-superuser

4. Access the Wagtail admin

Navigate to the admin URL in your browser, and sign in using the username/password combination you chose in the previous step.

http://127.0.0.1:8000/admin/

5. Compile the front-end assets

See https://nationalarchives.github.io/ds-wagtail/developer-guide/frontend/#setting-up-the-front-end-development-environment

Linux / OSX

If you are running a Unix based operating system, these alias commands may be useful to you to run inside the Docker container.

Running the development server:

djrun

Run migrations:

dj migrate

Create a super user:

dj createsuperuser

Issues with your local environment?

Check out the Local development gotchas page for solutions to common issues.

Discover more

• Documentation home
• Project conventions
• Backend development guide
• Frontend development guide
• Fetching data