https://github.com/oc8/django-rest-quickstart-template
Template to start a new project with django-rest / postgresql / docker
https://github.com/oc8/django-rest-quickstart-template
django django-rest-framework docker postgresql starter-template template
Last synced: 3 months ago
JSON representation
Template to start a new project with django-rest / postgresql / docker
- Host: GitHub
- URL: https://github.com/oc8/django-rest-quickstart-template
- Owner: oc8
- Created: 2023-01-05T18:28:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T12:07:11.000Z (over 1 year ago)
- Last Synced: 2025-01-26T07:26:00.110Z (4 months ago)
- Topics: django, django-rest-framework, docker, postgresql, starter-template, template
- Language: Python
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Django REST API Template
This is a Django project that can be easily extended to meet your needs. It uses Docker and PostgreSQL for easy development and deployment.
## Features
- Dockerized development and deployment
- PostgreSQL database
- Swagger and Redoc documentation
- Silky for API performance monitoring
- Unit tests
- Modular organization
## Prerequisites
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
## Installation
1. Clone this repository to your computer
2. Navigate to the project directory
3. Copy the `.env.example` file to `.env` and fill in the environment variables
4. Start the server with the command `make`
## Organization
.
│── backend (main folder)
│ │── models (database models)
│ │── views (views for the API)
│ │── serializers (serializers for the API)
│ │── services (modular service functions)
│ │── repositories (database queries)
│ │── tests (unit tests)
│ └── urls.py (API routes)
└── Makefile (make commands)
## Usage
### Redoc
The API is documented with Redoc. You can access the Redoc UI at `http://0.0.0.0:8000/redoc/`.
### Swagger
The API is documented with Swagger. You can access the Swagger UI at `http://0.0.0.0:8000/swagger/`.
### Silky
Silky is used to monitor API performance. You can access the Silky UI at `http://0.0.0.0:8000/silk/`.
### Unit tests
You can run the unit tests with the command `make test`.