756867da19
Our Pagination class inherits from the PageNumberPagination Django class. However, this base class as not ordering attribute. Thus, setting a default value wont have any effect on the code. Why did we end up passing a value to this non-existing attribute? Becasue we copy/pasted some code sources from Joanie, and Joanie also has this attribute set to a default value. If you take a look at DRF pagination style documentation, the only three attributes they set on the child class are 'page_size', 'max_page_size' 'page_size_query_param'. 'ordering' is not mentionned in the attributes you may override. However, the CursorPagination class offers the latter attribute, which may explain why we did end up setting this non-existing attribute in Joanie.
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).