keannu125/DRF_Template
1
0
Fork 0
mirror of https://github.com/lemeow125/DRF_Template.git synced 2025-09-17 21:19:41 +08:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions
A Django REST Framework template for building RESTful APIs
42 commits 1 branch 0 tags 883 KiB
Find a file
Keannu Bernasol 5afe6c28ab Generate active accounts on debug mode
2025-09-14 01:28:28 +08:00
.bruno/drf_template Implement tests 2025-09-13 20:05:13 +08:00
.docker Move to uv/pyproject and overhaul project structure 2025-09-01 02:10:28 +08:00
.woodpecker Add comments 2025-09-14 01:15:09 +08:00
src Generate active accounts on debug mode 2025-09-14 01:28:28 +08:00
.dockerignore Implement tests 2025-09-13 20:05:13 +08:00
.env.sample Generate active accounts on debug mode 2025-09-14 01:28:28 +08:00
.gitignore Move to uv/pyproject and overhaul project structure 2025-09-01 02:10:28 +08:00
.python-version Move to uv/pyproject and overhaul project structure 2025-09-01 02:10:28 +08:00
docker-compose.dev.yml Implement tests 2025-09-13 20:05:13 +08:00
docker-compose.yml Update Redis entry in docker-compose.yml files 2025-09-13 12:23:27 +08:00
Dockerfile Update Dockerfile 2025-09-01 02:24:43 +08:00
pyproject.toml Switch to faker for test data 2025-09-14 00:35:28 +08:00
README.md Update lint step 2025-09-13 21:11:30 +08:00
uv.lock Switch to faker for test data 2025-09-14 00:35:28 +08:00

README.md

DRF-Template

Build Status Demo Page Status

A barebones Django REST Framework template for personal use in projects.

  • Pre-templated emails
  • Caching via Redis
  • Debug mode profiling (via Django Silk)
  • Template CI/CD for automated builds/tests/linting/deployments (see service_queue for more info)

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

When using docker-compose.dev.yml, the entire project directory is mounted onto the container allowing for hot-reloading. This requires DEBUG to be set to True.

Also make sure to follow through the steps shown in the stripe-listener container for initial setup with Stripe.

Deployment

A sample docker-compose.yml is provided which I use in hosting the demo. DEBUG should be set to False when deploying as to not expose the URLs fro Celery Flower and the Django Silk Profiler. The local Inbucket container is not present with DEBUG turned off so make sure to specify an external SMTP server to process emails properly.

URLs