famalaquias / mongodb-car-shop

Back-End. Project developed in the Trybe Backend module

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MongoDB Car Shop 🌱 🛒

MONGODB

📃 Sobre

O projeto Car Shop tem como objetivo trabalhar com banco de dados MongoDB, que contém dados de uma concessionária de veículos. A partir disso, foi desenvolvido uma API RESTful utilizando a arquitetura MSC (Model, Service e Controller), a POO (Programação Orientada a Objetos) e os princípios de SOLID com TypeScript.

👨‍💻 Habilidades Desenvolvidas

  • Conexão do banco de dados MongoDB com o Node.js
  • Manipular e acessar os dados no banco de dados MongoBD
  • Criar uma API RESTful
  • Criar classes
  • Definir interfaces e types
  • Utilizar POO (Programação Orientada a Objetos)
  • Utilizar SOLID
  • Utilizar TypeScript
  • Utilizar o Mongoose.js
  • Implementar testes unitários com Mocha, Chai e Sinon

🛠️ Ferramentas Utilizadas

  • MongoDB
  • Mongoose.js
  • Node.js
  • Express
  • Mongoose.js
  • TypeScript
  • OOP
  • SOLID
  • Mocha.js
  • Chai.js
  • Sinon.js

🕵️‍♀️ Instruções de Instalação e Execução

Para rodar a aplicação é necessário ter o Git, MongoDb, Docker e o Docker Compose instalados na sua máquina.

Faça o clone do repositório e entre na pasta do projeto:

git clone git@github.com:famalaquias/mongodb-car-shop.git && cd mongodb-car-shop
Executando o MongoDB localmente

1 - Entre na pasta do projeto e utilize o comando npm install para instalar as dependências necessárias.

2 - Coloque a URI do MongoDB no arquivo ./src/models/connection.ts na variável MONGO_DB_URL.

3 - Utilize o comando npm run dev para inicializar a API.

Executando o MongoDB via Docker

1 - Entre na pasta do projeto e utilize o comando docker-compose up -d.

2 - Entre no terminal do container através do comando docker exec -it car_shop bash.

3 - Instale as dependências necessárias através do comando npm install.

4 - Utilize o comando npm run dev para inicializar a API.

🧪 Testes Unitários

Execute o comando abaixo no diretório raiz do projeto para rodar os testes:

npm run test:dev

Execute o comando abaixo no diretório raiz do projeto para verificar a cobertura de testes:

npm run test:coverage

TESTESCOVARAGE

About

Back-End. Project developed in the Trybe Backend module


Languages

Language:TypeScript 97.0%Language:JavaScript 2.6%Language:Dockerfile 0.4%