https://github.com/felipeversiane/bossabox_challange
RESTful API / Simple JWT / Swagger | Application based on a bossabox challenge.
https://github.com/felipeversiane/bossabox_challange
celery django drf drf-yasg jwt-authentication nginx redis simplejwt swagger
Last synced: 2 months ago
JSON representation
RESTful API / Simple JWT / Swagger | Application based on a bossabox challenge.
- Host: GitHub
- URL: https://github.com/felipeversiane/bossabox_challange
- Owner: felipeversiane
- License: mit
- Created: 2024-01-12T17:36:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-04T20:23:25.000Z (over 1 year ago)
- Last Synced: 2025-07-01T15:03:39.832Z (12 months ago)
- Topics: celery, django, drf, drf-yasg, jwt-authentication, nginx, redis, simplejwt, swagger
- Language: Python
- Homepage: https://bossabox.notion.site/Back-end-0b2c45f1a00e4a849eefe3b1d57f23c6
- Size: 3.64 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deploy Django and Nextjs using Nginx, Celery, Redis and Postgresql with Docker
RESTful API application based on a bossabox challenge.
[Challange Repository](https://bossabox.notion.site/Back-end-0b2c45f1a00e4a849eefe3b1d57f23c6)
## Basic Usage
1. First run **`make build`** inside root directory.
2. Then run **`make up`** to start up the project for first time.
Checkout the [commands](#commands) section for more usage.
## Preview
A default Django project resides in `src` directory. So, when you start the project, you will see the following screen in `8000` port:
## Commands
To use this project, run this commands:
1. `make up` to build the project and starting containers.
2. `make build` to build the project.
3. `make start` to start containers if project has been up already.
4. `make stop` to stop containers.
5. `make shell-web` to shell access web container.
6. `make shell-db` to shell access db container.
7. `make shell-nginx` to shell access nginx container.
8. `make logs-web` to log access web container.
9. `make logs-db` to log access db container.
10. `make logs-nginx` to log access nginx container.
11. `make collectstatic` to put static files in static directory.
12. `make log-web` to log access web container.
13. `make log-db` to log access db container.
14. `make log-nginx` to log access nginx container.
15. `make restart` to restart containers.
## Swagger | API Documentation (drf_yasg)
In swagger you will find the documentation for everything, all the methods and models routes and their respective attributes, you can access it through the route
#### Swagger
```http
GET /swagger
```
#### Redoc
```http
GET /doc
```
#