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)
• CI/CD pipeline templating with Woodpecker 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

Be sure to follow through the steps shown in the stripe-listener container for initial setup with Stripe!

URLs

• Django Admin
• OpenAPI Swagger (For testing endpoints)
• Inbucket (For email testing)
• Flower (For task monitoring)
• Django Silk (For performance profiling)