O objetivo deste projeto é criar uma API para gerenciar lugares e suas metas, onde é possível criar, listar, atualizar e excluir lugares, bem como atualizar suas metas.
- Node.js
- Express.js
- TypeScript
- TypeORM
- Jest
- Docker Compose
- Node.js (versão 14 ou superior)
- Docker (versão 20 ou superior)
- Docker Compose (versão 1.28 ou superior)
- Clone o repositório em sua máquina
- Instale as dependências do projeto com o comando
yar install
- Inicie o banco de dados e o servidor com o Docker Compose, executando o comando
docker-compose up -d
- Execute o projeto com o comando
yarn dev
Após seguir esses passos, o seu projeto deverá estar rodando em http://localhost:3333
.
Abaixo estão as rotas disponíveis na API:
POST /country
- Cria um paísPOST /place
- Cria um lugarGET /
- Lista todos os lugaresPATCH /place/update/:id
- Atualiza um lugar ou sua metaDELETE /place/delete/:id
- Exclui um lugar
Para executar os testes, execute o comando yarn test
. Os testes serão executados utilizando o Jest e serão exibidos no console.