Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/natlee/django-project-template
A template with many features of Docker, 3rd party login, JWT, websocket, Admin UI and django-q
https://github.com/natlee/django-project-template
3rd-party-login allauth django django-q django-rest-framework jwt-authentication project-template template websocket
Last synced: 3 months ago
JSON representation
A template with many features of Docker, 3rd party login, JWT, websocket, Admin UI and django-q
- Host: GitHub
- URL: https://github.com/natlee/django-project-template
- Owner: NatLee
- Created: 2023-02-15T02:07:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T06:11:50.000Z (4 months ago)
- Last Synced: 2024-10-23T08:40:42.154Z (4 months ago)
- Topics: 3rd-party-login, allauth, django, django-q, django-rest-framework, jwt-authentication, project-template, template, websocket
- Language: Python
- Homepage:
- Size: 2.98 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Django Backend Template
This is a Django backend template. It includes some useful features and tools.
## Requirements
Please specify the required variables in `.env` for this project.
## Features
- Docker
- Backend -> Django 5
- Database -> MariaDB
- Load Balancer -> NGINX
## Other Features
- API Proxy -> api_proxy
- User login history -> django_login_history
- Login Playground (Session, JWT) -> dev_dashboard
- 3rd Party Login with JWT -> Custom Allauth Adapter (authentication)
- Websocket(WSGI) -> Django Channels
- Async Task -> Django Q2
- Admin Page -> Django Unfold
- Documentation -> Redoc, Swagger
## Usage
### Quick Start
```bash
docker-compose build && docker-compose up
```
### Rebuild
Clean up and rebuild.
```bash
rm -rf backend-sql-data && docker-compose down -v && docker-compose build && docker-compose up
```
### 3rd Party Login
You can check the setting in [here](https://github.com/NatLee/Django-Simple-3rd-Party-JWT?tab=readme-ov-file#backend).
## Misc
- Create superuser
```bash
bash dev-create-superuser.sh
```
- Enter Shell
```bash
bash dev-shell.sh
```
- Start New APP
```bash
bash dev-startapp
```
## Playground
The playground is a place to test the login system and websocket.
- DEV dashboard: http://localhost:5566/api/__hidden_dev_dashboard
- Websocket Test Page: http://localhost:5566/api/ping/index
## Link
> Here's port `5566` is an example. You can define it in `.env` file.
- Admin: http://localhost:5566/api/__hidden_admin/
- Redoc: http://localhost:5566/api/__hidden_redoc
- Swagger: http://localhost:5566/api/__hidden_swagger