09cb7ff6f1
We will add a JWKs endpoint to the application and manipulate signed/encrypted Json Web Token (JWT). Project lacks tooling for JSON Object Signing and Encryption (JOSE) manipulations. After a quick benchmark, 'joserfc' has been chosen as the dependency to add. joserfc is a Python library that provides a comprehensive implementation of several essential JOSE standards. Please find the benchmark: - Cryptography: Although using only cryptography is feasible, its interface/API is not as user-friendly. - pyjwt: While pyjwt is popular, it lacks support for JWK and JWE objects, which are essential for the requirements. - python-jose: The latest release of python-jose was in 2021, and the project seems less active compared to other alternatives. - Authlib: Authlib is the second most popular library after pyjwt and seems modern with an active community. However, the parts relevant to the use case were extracted into a relatively new package named joserfc. - joserfc: Although joserfc has fewer stars compared to Authlib, it was extracted from Authlib, which has more than 4k stars, indicating a solid foundation. While the low star count of joserfc might raise concerns about its stability, it is believed to be worth considering its addition. Adding Authlib and refactoring later, once they finish migrating to joserfc, is also a possibility
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
You can then login with sub admin and password admin.
Run frontend
Run the front with:
$ make run-front-desk
Then access at http://localhost:3000
user: people
password: people
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).