Caronex Labs - DRF Boilerplate

Author: Sameeran Bandishti -> Founder - Caronex Labs

Overview:

A Django Rest Framework implementation that comes with a set of pre-implemented features commonly seen in most projects.

Features Implemented:

1. django-rest-auth package implemented along with the common settings and instructions to change them.
2. Custom login and registration serializers for django-rest-auth along with instructions on how to modify them.
3. drf-yasg package implemented along with the common url patterns to provide Swagger documentation out of the box.
4. A users_module along with implementations of AbstractUser, CustomUserManager and a UserAdmin class for Django's Admin Panel. Along with instructions on how to modify all of the above.
5. Email configuration settings, preset to work with Mailgun but will work with any provider.
6. python-dotenv package implemented and imported into settings.py. Information that is commonly stored in an env file has already been moved to the same.
7. A environment file template along with instructions to modify it.
8. A .gitignore file preset for Python projects, Visual Studio Code IDE, Jetbrains IDEs and other commonly ignored files.
9. The boilerplate is preconfigured to be ready to host on Heroku. It contains all the necessary packages and the Procfile. Along with any settings that need to be configured inside of settings.py.
10. django-cors-headers is implemented and the clickjacking middleware has been removed to ensure proper performance.
11. django-filters is implemented and has been added to the REST_FRAMEWORK.DEFAULT_FILTER_BACKENDS.
12. Both AnonRateThrottle and UserRateThrottle have been implemented along with instructions on how to set the Throttling Rates.
13. DEBUG set to False by default but Error Propagation is set to allow logging of errors to the server console even if not in debug mode.
14. Coverage calculation is setup using coveralls.
15. Pre-configured Dockerfiles for development and production.
16. Pre-configured Nginx server.
17. Pre-configured Travis-CI.
18. Pre-configured GitHub Actions

---

Instructions

1. On the Github Repository of this project, you'll find an option to Use this template on the top right.
2. Follow the prompts to create your new repository using this one as a template.
3. Clone your new repository to your local system.
4. Create your virtual environment and install all requirements with pip install -r requirements.txt
5. Run the following command: python manage.py configure. Answer any questions it asks to interactively set the project up.
6. Prompt your IDE/Code-Editor to index the project. The easiest way to do so is to just restart the IDE/Editor.
7. Go to the settings.py file and read through it. There are comments indicating any modifications you might want to make.
8. Go through every file inside of the users_module app and follow any instructions that apply to you.
9. Go through the templates provided, they contain instructions as well. These are generally the templates pertaining to the emails sent and the email confirmation pages.
10. Make migrations with the command: python manage.py makemigrations and then the command python manage.py makemigrations users_module and then apply them with python manage.py migrate
11. You then need to run the command: python manage.py collectstatic in order to collect and store the static files needed for the Admin panel. If you want to avoid doing this for some reason, you can also just set DEBUG=True in the settings.py file.
12. Before you continue to build your project, check the Admin Panel ('/admin/') and the swagger documentation ('/docs/') to ensure that the boilerplate has set up successfully. You will have to run the command python manage.py createsuperuser in order to access the Admin Panel.

---

References

• django-rest-auth
• drf-yasg
• django-cors-headers
• python-dotenv
• Configuring Django apps for Heroku
• Configuring Mailgun for Django
• Secret Key Generator for Django
• How to setup a Custom User Model

---

Roadmap

• django-rest-auth OAuth implementation
• A demo project inside the template
• Automating more of the setup using the custom management command.
  • Running collectstatic as a part of the setup.
  • Creating the virtual-environment and installing the requirements as a part of the setup.
  • Interactively setting up the User Model.
  • Interactively setting up the registration process (Email confirmation, email required, username required, etc.)