Skip to content
This repository has been archived by the owner on Aug 24, 2024. It is now read-only.

Backend do Planner, uma aplicação para gerenciamento de viagens

Notifications You must be signed in to change notification settings

bfukumori/nlw-journey-24-node-trail

Repository files navigation

Planner App API

Backend do Planner, uma aplicação de gerenciamento de viagens.

Ferramentas

  • NodeJs
  • Fastify
  • Vitest
  • Prisma
  • Zod
  • Typescript
  • Dayjs
  • Nodemailer
  • Swagger

Aprendizados importantes

  • Criação de uma REST API utilizando Node e Fastify
  • Criação de testes unitários utilizando Vitest
  • Conexão com envio de emails utilizando Nodemailer
  • Conexão com banco de dados utilizando Prisma
  • Validações utilizando Zod
  • Aplicações de princípios SOLID
  • Criação de documentação com Swagger

Como usar

Pré-requisitos

  • Node.js
  • npm

Instalação

  1. Clone o repositório:
git clone https://github.com/bfukumori/nlw-journey-24-node-trail.git
cd nlw-journey-24-node-trail
  1. Instale as dependências:
npm install
  1. Inicie a aplicação:
npm run dev

A API estará disponível em http://localhost:3333.

Comandos

# Abre uma aba para manipular o banco de dados em http://localhost:5555
npx prisma studio
# Preenche o banco com dados fictícios
npx prisma db seed
# Apaga o banco atual e refaz o seed
npx prisma migrate reset
# Roda os testes unitários
npm run test
# Gera o coverage report dos testes
npm run coverage
# Roda a aplicação utilizando o Docker
docker compose up -d

REST API

O arquivo client.http possui as chamadas para os endpoint, caso você tenha a extensão do REST Client instalada.

Documentação

A documentação foi gerada com o Swagger e se encontra em http://localhost:3333/docs.

About

Backend do Planner, uma aplicação para gerenciamento de viagens

Topics

Resources

Stars

Watchers

Forks