https://github.com/larissaperinoto/car-shop-api

API de gerenciamento para uma concessionária de veículos usando MongoDB.
https://github.com/larissaperinoto/car-shop-api

docker docker-compose eslint mongodb mongoose programacao-orientada-objetos swagger typescript

Last synced: 3 days ago
JSON representation

API de gerenciamento para uma concessionária de veículos usando MongoDB.

• Host: GitHub
• URL: https://github.com/larissaperinoto/car-shop-api
• Owner: larissaperinoto
• Created: 2023-01-19T20:26:29.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-19T22:32:34.000Z (almost 2 years ago)
• Last Synced: 2024-11-13T03:14:55.286Z (2 months ago)
• Topics: docker, docker-compose, eslint, mongodb, mongoose, programacao-orientada-objetos, swagger, typescript
• Language: TypeScript
• Homepage:
• Size: 208 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Car Shop API

A [Trybe](https://www.betrybe.com/) é uma escola de tecnologia com foco em formação de Desenvolvedores Web e o projeto Car Shop API Commerce foi proposto como atividade de aprimoramento dos estudos sobre desenvolvimento back-end utilizando Programação Orientada a Objetos e banco dados MongoDB. 

## Objetivo

A aplicação desenvolvida é uma API de gerenciamento para uma concessionária de veículos, onde é possível cadastar, atualizar, remover ou visualizar um veículo do banco de dados.

## Tecnologias e Ferramentas



    

    

    

    

    

    

      

    

    






Na elaboração deste projeto utilizou-se as seguintes ferramentas:

  

- [NodeJS](https://nodejs.org/en/)

- [Express](https://expressjs.com/pt-br/)

- [TypeScript](https://www.typescriptlang.org/)

- [Docker](https://www.docker.com/)

- [Mongoose](https://mongoosejs.com/)

- [MongoDB](https://www.mongodb.com/)

- Arquitetura Model-Service-Controller

### Testes

- [Mocha](https://mochajs.org/)

- [Sinon](https://sinonjs.org/)

- [Chai](https://www.chaijs.com/)

### Alinhamento de código

- [ESlint](https://eslint.org/)

### Documentação

- [Swagger](https://swagger.io/)

## ⚙️ Execução

  ⚠️ Para executar o projeto é necessário ter o [Docker](https://docs.docker.com/desktop/install/linux-install/) instalado em sua máquina.

  

Para executar a aplicação inicie realizando o clone deste repositório com o comando abaixo.

    git clone [email protected]:larissaperinoto/car-shop-api.git

Navegue até a raíz do projeto.

    cd car-shop-api/

Execute o comando para instalar as dependencias do projetos.

    npm install

    

Na raíz do projeto, suba os containers do **car_shop** e **car_shop_db** com o comando abaixo

    docker-compose up -d

Inicie o servidor com o comando abaixo

    npm run dev

  

Rode os testes da aplicação usando o seguinte comando

    npm run test:mocha

## Documentação da API

Para acessar a documentação da API acesse no seu navegador o endereço localhost:3001/docs após seguir os passos de execução do projeto como descritos no tópico Execução.

saiba mais

![Captura de tela de 2023-01-19 19-28-10](https://user-images.githubusercontent.com/98956659/213576865-5a18118c-cbf0-4eff-9f6c-e08c6a4e5aa2.png)

---

Desenvolvido por [Larissa Perinoto](http://www.linkedin.com/in/larissaperinoto), © 2023.