Skip to content

Setup

Prerequisites:

  • This project uses pdm ⧉ as package manager
  • A Postgres DB v14+
  • A Redis server

Note

PDM will create a virtualenv in /.venv, and install dependencies into it. If you wand to change this behaviour please read the PDM Documentation ⧉

Create virtualenvironment

  1. Checkout code

    git clone https://github.com/unicef/hope-aurora
git config branch.autosetuprebase always

  2. In the shell:

    pdm venv create
pdm use
pdm venv activate

  3. Check your virtualenv is properly created

    pdm info

  4. Install the package

     pdm install
 pdm run pre-commit install

  5. Add export PYTHONPATH="$PYTHONPATH:./src"

  6. Check your environment:

    ./manage.py env --check and configure the missing variables.

    Hint

    You can generate a list for your development environment with the command 

    ./manage.py env --develop --config --pattern='export {key}={value}'

  7. Run upgrade command to properly initialize the application:

    ./manage.py upgrade --admin-email ${ADMIN_EMAIL} --admin-password ${ADMIN_PASSWORD}

    Note

    Django migrations and collectstatic commands are automatically included in this step

Configure environment for .direnv

If you want to use direnv ⧉ and automatic loading of environment variables from a .envrc file:

./manage.py env --develop --config --pattern='{key}={value}' > .envrc

echo 'export PYTHONPATH="$PYTHONPATH:./src"' >> .envrc
echo 'eval $(pdm venv activate)' >> .envrc
echo "unset PS1" >> .envrc

Warning

The first time after you have created or modified the .envrc file you will have to authorize it using:

direnv allow

Run

To start working with Aurora you can:

Build and use your docker

After you have cloned the repo, be sure to have a Reddis and PostgreSQL server running on your machine

export ADMIN_EMAIL=admin@example.com
export ADMIN_PASSWORD=password
export DATABASE_URL=postgres://postgres:@127.0.0.1:5432/aurora
export CACHE_URL=redis://127.0.0.1:6379/1?client_class=django_redis.client.DefaultClient

cd docker

make build run

Use provided compose.yml

docker compose up

navigate to http://localhost:8000/admin/ and login using admin@example.com/password

Setup HOPE integration

  • Add aurora_token in the user
  • Add aurora_server in the Constance Config
  • Fetch data from Aurora
  • Associate Organizations to Business Areas
  • Associate Projects to Programmes