A Django REST Framework template for building RESTful APIs
Find a file
2024-08-30 17:58:00 +08:00
backend Update .env values and set up woodpecker.yml 2024-08-30 16:52:15 +08:00
documentation/erd Overhauled entire project config, added notifications, email templates, optimized stripe subscriptions, redis caching, and webdriver utilities 2024-05-10 23:15:29 +08:00
.dockerignore Update .env values and set up woodpecker.yml 2024-08-30 16:52:15 +08:00
.env.sample Update .env values and set up woodpecker.yml 2024-08-30 16:52:15 +08:00
.gitignore Move production server to granian from gunicorn 2024-06-04 20:19:13 +08:00
.prettierignore Overhauled entire project config, added notifications, email templates, optimized stripe subscriptions, redis caching, and webdriver utilities 2024-05-10 23:15:29 +08:00
.woodpecker.yml Fix Docker registry credentials 2024-08-30 17:58:00 +08:00
docker-compose.yml Update .env values and set up woodpecker.yml 2024-08-30 16:52:15 +08:00
Dockerfile Disable chromedriver 2024-08-30 17:37:49 +08:00
Pipfile Move production server to granian from gunicorn 2024-06-04 20:19:13 +08:00
Pipfile.lock Move production server to granian from gunicorn 2024-06-04 20:19:13 +08:00
README.md Fixed email templates failing to load and updated README.md 2024-05-10 23:46:48 +08:00
requirements.txt Move production server to granian from gunicorn 2024-06-04 20:19:13 +08:00
seed_data.json Overhauled entire project config, added notifications, email templates, optimized stripe subscriptions, redis caching, and webdriver utilities 2024-05-10 23:15:29 +08:00
start.sh Move production server to granian from gunicorn 2024-06-04 20:19:13 +08:00

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