1a3b396230
To facilitate deployment on Kubernetes, we've introduced a Docker image for the frontend. The Next.js project is built, and its static output is served using an Nginx reverse proxy. Since DevOps lacks a certified cold storage solution (e.g., S3) for serving static files, we've decided to containerize the frontend as a quick workaround for deploying staging environments. Please note this Docker Image is WIP. One of the main issue still not resolved concerns environment variables, which are only available when building the Docker Image. Thus, having different environment variables values between environment (dev, pre-prod, prod) will require us to build several frontend images, and tag them with the appropriate target environment. The `.env.production` values are not the final ones. For now, they were set to dev values. It allows us to test the frontend image with the development setup. Important: The frontend image is built-on top of an unprivileged Nginx image, which exposes by default port 8080 instead of 80 for classic Nginx image. You can find more info https://github.com/nginxinc/docker-nginx-unprivileged. The Docker Compose Nginx service is used to proxy OIDC requests to keycloak, in order to share the same host when initiating an OIDC flow, from outside and inside docker virtual network. All Nginx configurations related to serve frontend static build were moved to a newly created conf file under src/frontend/apps/desk. When starting the frontend image, we desire to start the minimum Nignx config required to serve frontend statics.
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).