Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raelnogpires/car-shop
API REST built using TypeScript, Express, Mongoose. OOP and SOLID concepts.
https://github.com/raelnogpires/car-shop
Last synced: about 2 months ago
JSON representation
API REST built using TypeScript, Express, Mongoose. OOP and SOLID concepts.
- Host: GitHub
- URL: https://github.com/raelnogpires/car-shop
- Owner: raelnogpires
- Created: 2022-08-15T20:17:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-07T19:53:29.000Z (over 2 years ago)
- Last Synced: 2024-11-05T10:46:11.439Z (3 months ago)
- Language: TypeScript
- Size: 395 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://docs.docker.com/engine/install/) e [Docker Compose](https://docs.docker.com/compose/install/) em sua máquina para executar a aplicação e testes.
1. Clone o repositório:
```sh
git clone [email protected]:raelnogpires/car-shop.git
```
2. Entre no repositório:
```sh
cd car-shop
```
4. Execute o docker-compose:
```sh
docker-compose up -d
```
Ela estará disponível em `http://localhost:3001` .
Para executar os testes, execute:
```sh
docker exec -it car_shop npm run test:dev
```
Para parar a aplicação, execute:
```sh
docker-compose down
```
## Documentação
A documentação desta API está sendo escrita no momento.