bbd8e1b48d
First, thanks a LOT @rouja for your help along the way. This commit propose a first draft of Helm chart to prepare deployment. It follows Plane's Helm Chart, hosted on the shared team repo, please https://github.com/numerique-gouv/helm-charts, PR #11 It offers advanced templating function under _helpers.tpl, an auto-generated README file when running ./generate-readme.sh, and a clear files structure. The chart itself is quite simple. We have two deployments, one for the frontend and one for the backend. Both need a dedicated service, which are exposed using a common ingress. Frontend is accessible from the / path and backend's from /api path. Please note, we added a backend job to migrate the database when deploying backend's pods. This job should be auto-cleaning itself 100s after it completes to avoid any error when syncing helm. values.yaml file is quite pristine, all common env variables will be set in helmfile configuration. Deploying frontend static files through kubernetes is temporary, we plan to either remplace it by an external CDN or use minio to host static output in a S3 bucket within the cluster.
People
People is an application to handle users and teams.
As of today, this project is not yet ready for production. Expect breaking changes.
People is built on top of Django Rest Framework.
Getting started
Prerequisite
Make sure you have a recent version of Docker and Docker Compose installed on your laptop:
$ docker -v
Docker version 20.10.2, build 2291f61
$ docker compose -v
docker compose version 1.27.4, build 40524192
⚠️ You may need to run the following commands with
sudobut this can be avoided by assigning your user to thedockergroup.
Project bootstrap
The easiest way to start working on the project is to use GNU Make:
$ make bootstrap
This command builds the app container, installs dependencies, performs
database migrations and compile translations. It's a good idea to use this
command each time you are pulling code from the project repository to avoid
dependency-related or migration-related issues.
Your Docker services should now be up and running 🎉
Note that if you need to run them afterward, you can use the eponym Make rule:
$ make run
Adding content
You can create a basic demo site by running:
$ make demo
Finally, you can check all available Make rules using:
$ make help
Django admin
You can access the Django admin site at http://localhost:8071/admin.
You first need to create a superuser account:
$ make superuser
Contributing
This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions.
License
This work is released under the MIT License (see LICENSE).