/car-shop

API REST built using TypeScript, Express, Mongoose. OOP and SOLID concepts.

Primary LanguageTypeScript

Car Shop

Este projeto foi desenvolvido no bloco 30 da Trybe, sendo seu objetivo criar uma API REST utilizando TypeScript, Express, Mongoose e conceitos de POO e SOLID.

Habilidades desenvolvidas

  • Programação Orientada a Objetos.
  • SOLID.
  • Testes Unitários.
  • Operações de CRUD utilizando MongoDB e Mongoose.

Executando a aplicação

Será necessário ter instalado as tecnologias Docker e Docker Compose em sua máquina para executar a aplicação e testes.

  1. Clone o repositório:
 git clone git@github.com:raelnogpires/car-shop.git
  1. Entre no repositório:
 cd car-shop
  1. Execute o docker-compose:
 docker-compose up -d

Ela estará disponível em http://localhost:3001 .

Para executar os testes, execute:

 docker exec -it car_shop npm run test:dev

Para parar a aplicação, execute:

 docker-compose down

Documentação

A documentação desta API está sendo escrita no momento.