Git Product home page Git Product logo

delivery-api's Introduction

DELIVERY API

Api de entrega de Encomendas Cliente-Entregador

🔗 NodeJS

🚀 API para Entrgas de encomendas entre Cliente-Entregador até sua finalização na entrega da encomenda.

Como InstalarFeaturesTecnologiasLicençaAutor

Instalar

Faça o download do projeto para sua maquina via terminal com git clone [https://github.com/danivaldosousa/delivery.git](https://github.com/danivaldosousa/delivery.git)

Depois de baixado, acesse a pasta do projeto e rode o comando abaixo no terminal de sua maquina, e será instalado todas dependências do projeto.

yarn

Configurar o arquivo .env_example primeiro renomeando para .env e posteriormente substituindo as váriaveis de conexão para as suas informações correspondete.

Para a criação da Base de dados em Postgres execute o comando.

yarn prisma migrate dev

Para o executar o programa em modo de desenvolvimento execute a linha abaixo.

yarn dev

Para o executar o programa em modo de Produção crie a pasta .dist na raiz do projeto, e depois execute o comando abaixo.

yarn tsc

e depois

yarn build

Tecnologias

  • NodeJS *
  • Typescript *
  • Express *
  • Os principios do SOLID
  • JWT - JsonWebToken
  • dotenv
  • Prisma.io / ORM e gerenciador dos dados (SQlite, Postgres, Mysql, MongoDB)
  • Swagger / Para documentação da API e teste em browse dos recursos. (Para Atualizaçõe Futuras)

Features

  • Cadastro de Clientes
  • Cadastro de Entregadores
  • Cadastro de encomendas pelo cliente
  • Pesquisa de encomendas livres - Entregador
  • Pesquisa de encomendas por cliente
  • Atualização entrega de encomenda - Entragador

Recursos

/client/ - Recurso para cadastro de clientes.

<http://localhost.3333/client>

/client/authenticate/ - Recurso para autenticação do cliente no serviço de entrega.

<http://localhost.3333/i/client/authenticate/>

/deliveryman - Recurso para cadastro do Entregador.

<http://localhost.3333/deliveryman>

/deliveryman/authenticate - Recurso para a autenticação do Entregdor no serviço de entrega.

<http://localhost.3333/deliveryman/authenticate>

/delivery - Recurso para cadastro de uma Entrega

<http://localhost.3333/delivery>

/delivery/available - Recurso para pesquisa do Entregas sem entregador

<http://localhost.3333/delivery/available>

/delivery/updateDeliveryman/:id - Recurso para o entregador assumir uma entrega para si

<http://localhost.3333/delivery/updateDeliveryman/:id>

/client/deliveries - Recurso para exibir todas as Entregas do cliente

<http://localhost.3333/client/deliveries>

/deliveryman/deliveries - Recurso para exibir todas as Entregas do Entregador

<http://localhost.3333/deliveryman/deliveries>

Licença

MIT License

Autor

**Danivaldo Sousa**

delivery-api's People

Stargazers

 avatar  avatar

Watchers

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