API El Buen Conejo

An API for the next plattform of Buen Conejo!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

It is a project to congregate rabbit farmers, trading rabbits, meat, and other derivate products, and finally share statistics with the community, industry, and government.

In this project the objetives are:

• Create a local database with PostgreSQL through Django ORM
• Use JWT with custom user model
• Login with username, email and password
• Send email for activate users
• Create the REST API for CRUD operations through Django Rest Framework
• Use Swagger for document the REST API
• Upload photos for profiles, cages, farms and rabbbits in Cloudinary service
• Use docker containers and docker compose

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

This project use a postgreSQL database and docker container in local mode and production.

Installation

1. Clone the repository

   git clone git@github.com:el-buen-conejo/elbuenconejo-backend.git

2. In local mode install docker and docker compose
3. Create a .env file with the environment variables of the .env.example file
4. Execute the next command with docker compose

   docker compose up -d 

(back to top)

Usage

In the next link can you use the API, the indications are: For endpoints of methods different from GET

1. Create an user with the endpoint: /api/auth/register/ of swagger ui url
2. Copy access token
3. Click in authorized button
4. Paste acces token in value field
5. Click in Authorize button
6. Click in close button
7. Can you use the API
8. Logout in authorize button

For endpoints of methods GET only excute the endpoint in swagger ui url

For more examples, please refer to the Documentation

(back to top)

Roadmap

• [ X ] Add CI/CD with Github Actions
• [ X ] Terminate swagger documentation
• [ ] Add versioning control
• [ X ] Deploy in Railway

See the open issues for a full list of proposed features (and known issues).

(back to top)

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Miguel Angel López Monroy - @miguellopezmdev - miguel.lopezm.dev@gmail.com

Project Link: https://elbuenconejo-backend-production.up.railway.app/api/schema/swagger-ui/

(back to top)

Acknowledgments

My favorite resources used:

• Choose an Open Source License
• Django Documentation
• Django Rest Framework Documentation
• Django Class Based View Inspector
• Classy Django Rest Framework
• Platzi Platform
• Udemy Platform
• Real Python Tutorials
• Blog Developer.pe

(back to top)