OHOS (follows 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/

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
5. Starts development server

2. Access the site

http://127.0.0.1:8000

3. Create a Django user for yourself

# ...from within the dev container
fab dev
manage 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.

6. Syncing OHOS fork from Etna from Command line

git checkout develop
git pull

git remote -v
# should see
# origin  git@github.com:nationalarchives/ds-ohos-wagtail.git (fetch)
# origin  git@github.com:nationalarchives/ds-ohos-wagtail.git (push)
# upstream        https://github.com/nationalarchives/ds-wagtail.git (fetch)
# upstream        https://github.com/nationalarchives/ds-wagtail.git (push)

# if not, then
git remote add upstream https://github.com/nationalarchives/ds-wagtail.git
#

git remote -v
git checkout develop
git fetch upstream

# NOTE: 
# - Keep out non OHOS related bits- ex: whatson, collections, etc
# - look out for any overritten bits from Etna
# - ideally OHOS related bits should overwrite Etna bits
git merge upstream/develop

# check, fix and commit
# run ohos local and check 
git push

7. Feature/Fix/Chore work

Create ticket branch off ds-ohos-wagtail:develop

8. Deploy OHOS

Merge PR into ds-ohos-wagtail:develop

Merge ds-ohos-wagtail:develop into ohos - this will kickoff a CD process to deploy to OHOS

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.

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