Developmentο
Clone projectο
git clone --recurse-submodules git@github.com:Terralego/TerraVisu.git
Prepare stackο
cp db.env.dist db.env
cp app.env.dist app.env
docker compose build
Init databaseο
docker compose run --rm web ./manage.py migrate
Load initial dataο
docker compose run --rm web ./manage.py loaddata project/fixtures/initial.json
Create your superuserο
docker compose run --rm web ./manage.py createsuperuser
Prepare admin if requiredο
make build_admin
Prepare frontend if requiredο
make build_front
Launch stackο
docker compose up
Accessο
Frontendο
Adminο
Django admin (config / debug)ο
Lintingο
We use flake8, isort and black rules. You can run :
make lint
to check them
Modificationο
Each modification should be done in a Pull request correctly named and labeled (dependencies, bug, enhancement, β¦) with a changelog entry.
Release processο
Changelog should be up to date
assign version number in project/VERSION and docs/source/changelog.rst with date (version in the form YYYY.MM.XX where YYYY is the year, MM the month, XX the release number in the month.)
Use Release fonction in github to create a release with the same name as the version number
Use release notes button to generate release notes
CI publish a new docker image.
Back to dev by adding β+devβ to project/VERSION and new changelog section with XXXX-XX-XX date and version