mirror of
https://github.com/lemeow125/DRF_Template.git
synced 2024-11-17 04:09:25 +08:00
A Django REST Framework template for building RESTful APIs
backend | ||
documentation/erd | ||
.dockerignore | ||
.env.sample | ||
.gitignore | ||
.prettierignore | ||
.woodpecker.yml | ||
docker-compose.yml | ||
Dockerfile | ||
Pipfile | ||
Pipfile.lock | ||
README.md | ||
requirements.txt | ||
seed_data.json | ||
start.sh |
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)
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 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)