DRF_Template/README.md

DRF-Template

This is a Django template that I personally use for my projects. This covers the following

• Emails (and templated email designs)
• Celery (For asynchronous tasks)
• Celery Beat (For scheduled tasks)
• Caching (via Redis)
• Performance profiling (via Django Silk)
• Selenium (Optional, for webscraping with support for Chrome and Firefox drivers)
• Stripe Subscriptions (Optional, with regular and pro-rated subscription support)
• Notifications (via traditional RESTful endpoints)
• A working Woodpecker CI/CD template for automated deployments

A live API demo can be found here

Development

• Create a copy of the .env.sample file and name it as .env in the same directory
• Populate .env with values
• Run docker-compose -f docker-compose.dev.yml up

When using docker-compose.dev.yml, the entire project directory is mounted onto the container allowing for hot-reloading. Make sure DEBUG is set to True for this to work! Be sure to follow through the steps shown in the stripe-listener container for initial setup with Stripe!

Deployment

A sample docker-compose.yml is provided which I use in hosting the demo. DEBUG should be set to False when deploying as to not expose the URLs fro Celery Flower and the Django Silk Profiler. The local Inbucket container is not present so make sure to specify an external SMTP server to process emails properly.

URLs

• Django Admin Panel
• OpenAPI Swagger (For documenting endpoints)
• Inbucket (For email testing)
• Flower (For monitoring Celery tasks)
• Django Silk (For performance profiling)