Code Monkey home page Code Monkey logo

litoral-delivery-api's Introduction

📝 README

API de Entregas e Inclusão Digital

Uma API REST desenvolvida em Django com Django Rest Framework (DRF) para servir dois apps: um serviço de entrega e outro inclusão digital de lojistas e empreendedores nas pequenas cidades do Maranhão.

Funcionalidades

  • [ ]Cadastro de usuários (clientes, lojistas e entregadores) 👥
  • [ ]Autenticação e autorização de usuários com token JWT 🔐
  • [ ]Cadastro e gerenciamento de pedidos de entrega 🚚
  • [ ]Cadastro e gerenciamento de produtos dos lojistas 🛍️
  • [ ]Cadastro e gerenciamento de lojas dos lojistas 🏪
  • [ ]Cadastro e gerenciamento de entregadores e suas rotas 🗺️
  • [ ]Controle de estoque dos produtos 📊

Tecnologias utilizadas

  • Django 🐍
  • Django Rest Framework 🌐
  • PostgreSQL 🐘

Instalação

  1. Clone o repositório:
git clone https://github.com/ivictoruan/litoral-delivery-api
  1. Crie e ative um ambiente virtual:
python -m venv env
source env/bin/activate
  1. Instale as dependências do projeto:
pip install -r requirements.txt
  1. Crie um banco de dados PostgreSQL e configure as variáveis de ambiente com as informações de acesso:
[Acesse a documentação para mais informações](https://www.postgresql.org/)
  1. Execute as migrações para criar as tabelas do banco de dados:
python manage.py migrate
  1. Crie um superusuário para acessar a área de administração:
python manage.py createsuperuser
  1. Inicie o servidor:
python manage.py runserver

Endpoints

  • [ ]/api/v1/users/: endpoint para cadastro de usuários;
  • [ ]/api/v1/token/: endpoint para autenticação de usuários e geração de token JWT;
  • [ ]/api/v1/orders/: endpoint para cadastro e gerenciamento de pedidos de entrega;
  • [ ]/api/v1/products/: endpoint para cadastro e gerenciamento de produtos dos lojistas;
  • [ ]/api/v1/stores/: endpoint para cadastro e gerenciamento de lojas dos lojistas;
  • [ ]/api/v1/drivers/: endpoint para cadastro e gerenciamento de entregadores e suas rotas;
  • [ ]/api/v1/stock/: endpoint para controle de estoque dos produtos.

Licença

Este projeto está licenciado sob a Licença MIT. Consulte o arquivo LICENSE para obter mais informações.

Contato

Email LinkedIn GitHub

litoral-delivery-api's People

Contributors

ivictoruan avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.