keannu125/DRF_Template
1
0
Fork 0
mirror of https://github.com/lemeow125/DRF_Template.git synced 2024-11-17 04:09:25 +08:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions
A Django REST Framework template for building RESTful APIs
40 commits 1 branch 0 tags 636 KiB
Python 94.8%
HTML 3.7%
Shell 0.8%
Dockerfile 0.7%
Find a file
Keannu Bernasol 2ad01419cd Update README.md
2024-08-30 22:46:40 +08:00
backend Rework CSRF and improved .woodpecker.yml 2024-08-30 19:28:24 +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 README.md and fix deployment step in .woodpecker.yml 2024-08-30 19:44:37 +08:00
.env.sample Rework CSRF and improved .woodpecker.yml 2024-08-30 19:28:24 +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 bindmount on celery beat container causing missing file errors 2024-08-30 22:27:33 +08:00
docker-compose.demo.yml Fix bindmount on celery beat container causing missing file errors 2024-08-30 22:27:33 +08:00
docker-compose.dev.yml Fix directory and image tags not being read properly 2024-08-30 21:34:01 +08:00
Dockerfile Fix missing start.sh 2024-08-30 22:15:20 +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 Update README.md 2024-08-30 22:46:40 +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 Simplify startup script 2024-08-30 21:57:49 +08:00

README.md

DRF-Template

Build Status Demo Page Status

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