Skip to content

Latest commit

 

History

History
executable file
·
111 lines (80 loc) · 3.29 KB

README-pt-BR.md

File metadata and controls

executable file
·
111 lines (80 loc) · 3.29 KB
Raw

Badge em Desenvolvimento

GitHub contributors GitHub discussions GitHub issues GitHub pull request

Este readme também pode ser lido em Português ou English.

Delivery API

Este é o backend para o sistema de entrega, desenvolvido utilizando Node.js, Express, Typescript, Prisma ORM com PostgreSQL e Swagger para documentação da API.

Estrutura do Projeto

  • src/controllers: Contém os controladores das rotas.
  • src/repositories: Contém os repositórios para interagir com o banco de dados.
  • src/services: Contém os serviços que implementam a lógica de negócio.
  • src/http/server.ts: Arquivo de entrada do servidor Express.
  • src/http/routes/index.ts: Contém as rotas da aplicação.

Documentação da API

A documentação completa da API pode ser acessada em http://localhost:5555/api-docs após iniciar o servidor. A documentação é gerada utilizando Swagger.

Requisitos

  • Node.js v20.0.0 ou superior
  • PostgreSQL
  • pnpm ou npm
  • Docker

Instalação

  1. Clone o repositório:
git clone https://github.com/ThiLourenco/delivery-backend.git
cd delivery-backend
  1. Instale as dependências:
pnpm install
ou
npm install
  1. Instalação com Docker:

Este repositório contém os artefatos necessários para executar usando Docker. Primeiro de tudo, você precisará instalar alguns pré-requisitos, caso ainda não estejam instalados:

  docker compose up
  1. Configure o banco de dados PostgreSQL e crie um arquivo .env na raiz do projeto com a URL do banco de dados:
DATABASE_URL=postgresql://<usuario>:<senha>@<host>:<porta>/<database>?schema=public
  1. Execute as migrações do Prisma para criar as tabelas no banco de dados:
npx prisma migrate dev --name init
  1. Gere o cliente Prisma:
npx prisma generate

Executando o Servidor

Para iniciar o servidor em modo de desenvolvimento, use:

pnpm dev
ou
npm run dev

O servidor será iniciado em http://localhost:5555 ou sua porta preferida.

Executando testes

pnpm test
or 
npm run test

Contribuição

Se você deseja contribuir com este projeto, siga os passos abaixo:

  1. Faça um fork do repositório.
  2. Crie uma branch para sua feature (git checkout -b minha-feature).
  3. Commit suas alterações (git commit -am 'Adiciona nova feature').
  4. Envie para o branch (git push origin minha-feature).
  5. Crie um novo Pull Request.

Contribuidores

Licença

Este projeto está licenciado sob a licença MIT. Veja o arquivo MIT License para mais detalhes.