felipeversiane / bossabox_challange

RESTful API / Simple JWT / Swagger | Application based on a bossabox challenge.

Deploy Django and Nextjs using Nginx, Celery, Redis and Postgresql with Docker

RESTful API application based on a bossabox challenge.

Challange Repository

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 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

  GET /swagger

Redoc

  GET /doc