056bad08a5
In development, sessions are saved in local memory. It's working well, however it doesn't adapt to a kubernetized setup. Several pods need to access the current sessions, which need to be stored in a single source of truth. With a local memory cache, pods cannot read session saved in other pods. We end up returning 401 errors, because we cannot authenticate the user. I preferred setting up a proper cache than storing sessions in database, because in the long run it would be a performance bottleneck. Cache will decrease data access latency when reading current sessions. I added a Redis cache backend to the production settings. Sessions would be persisted to Redis. In K8s, a Redis operator will make sure the cached data are not lost. Two new dependencies were added, redis and django-redis. I followed the installation guide of django-redis dependency. These setting were tested deploying the app to a local K8s cluster.
Impress
Impress prints your markdown to pdf from predefined templates with user and role based access rights.
Impress is built on top of Django Rest Framework and Next.js.
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-releated or migration-releated issues.
Your Docker services should now be up and running 🎉
Note that if you need to run them afterwards, 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).