2024-05-10 23:15:29 +08:00
|
|
|
## DRF-Template
|
|
|
|
|
|
2024-08-30 19:28:24 +08:00
|
|
|
|
2024-08-30 19:44:37 +08:00
|
|
|
|
2024-08-30 19:28:24 +08:00
|
|
|
|
2024-05-10 23:46:48 +08:00
|
|
|
This is a Django template that I personally use for my projects. This covers the following
|
2024-05-10 23:15:29 +08:00
|
|
|
|
|
|
|
|
- Emails (and templated email designs)
|
|
|
|
|
- Celery (For asynchronous tasks)
|
|
|
|
|
- Celery Beat (For scheduled tasks)
|
2024-05-10 23:46:48 +08:00
|
|
|
- Caching (via Redis)
|
2024-05-10 23:15:29 +08:00
|
|
|
- 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)
|
2024-08-30 22:46:40 +08:00
|
|
|
- CI/CD pipeline templating with Woodpecker for automated deployments
|
|
|
|
|
|
|
|
|
|
A live API demo can be found [here](https://api.template.06222001.xyz/swagger)
|
2024-05-10 23:15:29 +08:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
- Create a copy of the `.env.sample` file and name it as `.env` in the same directory
|
|
|
|
|
- Populate .env with values
|
2024-08-30 22:46:40 +08:00
|
|
|
- Run `docker-compose -f docker-compose.dev.yml up`
|
2024-05-10 23:46:48 +08:00
|
|
|
|
|
|
|
|
Be sure to follow through the steps shown in the `stripe-listener` container for initial setup with Stripe!
|
|
|
|
|
|
|
|
|
|
## URLs
|
|
|
|
|
|
|
|
|
|
- [Django Admin](http://localhost:8000/admin)
|
|
|
|
|
- [OpenAPI Swagger](http://localhost:8000/swagger) (For testing endpoints)
|
|
|
|
|
- [Inbucket](http://localhost:8025) (For email testing)
|
|
|
|
|
- [Flower](http://localhost:5555/) (For task monitoring)
|
|
|
|
|
- [Django Silk](http://localhost:8000/silk) (For performance profiling)
|
