Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gemaquejr/car-shop

Projeto com o objetivo de desenvolver uma API RESTful utilizando Typescript, MongoDB e Mongoose em um CRUD (Create, Read, Update e Delete) de uma concessionária de veículos. Este projeto foi criado para avaliação final na seção 12 do módulo de Backend do Curso de Desenvolvimento Web na Trybe.
https://github.com/gemaquejr/car-shop

api chai docker mocha mongodb mongoose nosql-database poo sinon typescript

Last synced: 10 days ago
JSON representation

Projeto com o objetivo de desenvolver uma API RESTful utilizando Typescript, MongoDB e Mongoose em um CRUD (Create, Read, Update e Delete) de uma concessionária de veículos. Este projeto foi criado para avaliação final na seção 12 do módulo de Backend do Curso de Desenvolvimento Web na Trybe.

Awesome Lists containing this project

README 

        
# Car Shop



Essa aplicação é uma API RESTful de uma concessionária de veículos em MongoDB e Mongoose.



Aplicação que consiste em desenvolver uma API RESTful de gerenciamentos de uma concessionária de veículos, onde é possível cadastrar, visualizar, pesquisar, editar e excluir informações.



O projeto foi para praticar a construção de API's RESTful em CRUD, utilizando endpoints para ler e escrever arquivos em MongoDB, além do framework Mocha e das bibliotecas Chai e Sinon.JS para criar os testes unitários.



## 🚀 Tecnologia



- ⚡ Docker é uma plataforma open source que facilita a criação e administração de ambientes isolados dentro de um container.



- ⚡ Node.js é um ambiente de execução JavaScript que permite executar aplicações desenvolvidas com a linguagem de forma autônoma, sem depender de um         navegador.



- ⚡ MongoDB é um software de banco de dados orientado a documentos livre, de código aberto e multiplataforma, escrito na linguagem C++.



- ⚡ Mongoose é uma biblioteca de programação orientada a objetos JavaScript que cria uma conexão entre o MongoDB e o ambiente de tempo de execução           JavaScript Node.js.



- ⚡ Mocha é um Framework de teste JavaScript para programas Node.js.



- ⚡ Chai é uma biblioteca de afirmação BDD/TDD para Node e para o navegador, que pode ser equiparada com qualquer framework de testes de JavaScript.



- ⚡ Sinon é uma biblioteca que fornece diversas funcionalidades (como mocks, spies e stubs) que facilitam os desenvolvimentos de testes no JavaScript.



- ⚡ Jest é uma estrutura de teste de JavaScript construída sobre o Jasmine e mantida pela Meta.



## ✋🏻 Pré-requisitos



- [git](https://git-scm.com/downloads): Ferramenta para gerenciar o código-fonte



- [Visual Studio Code](https://code.visualstudio.com/): Editor de Código Fonte



- [Docker](https://www.docker.com/): Software de código aberto usado para implantar aplicativos dentro de containers virtuais.



- [Node.js](https://nodejs.org/en): Software de código aberto, multiplataforma, baseado no interpretador V8 do Google e que permite a execução de códigos   JavaScript fora de um navegador web.



- [MongoDB](https://www.mongodb.com/): É uma nova ideia de banco de dados trazendo conceitos de Banco de Dados Orientado a Documentos.



- [Mongoose](https://mongoosejs.com/): É uma biblioteca de Modelagem de Dados de Objeto (ou ODM, do inglês: Object Data Modeling) para MongoDB e Node.js.



- [Mocha](https://mochajs.org/): Mocha é um framework Javascript que roda em aplicações Node.js e no browser para realizar testes assíncronos de uma       maneira simples e fácil.



- [Chai](https://www.chaijs.com/): Chai é uma biblioteca de afirmação BDD/TDD para Node e para o navegador, que pode ser equiparada com qualquer           framework de testes de JavaScript.



- [Sinon](https://sinonjs.org/): Sinon é uma biblioteca que fornece diversas funcionalidades (como mocks, spies e stubs) que facilitam os                   desenvolvimentos de testes no JavaScript.



- [Jest](https://jestjs.io/pt-BR/): Jest é um framework de testes em JavaScript com um foco na simplicidade.



## :hammer_and_wrench: Antes de iniciar o projeto.



### `Obrigatório ter o MongoDB instalado`



- Ter um servidor MongoDB no computador



- Ter um cliente MongoDB e conectá-lo ao servidor



No diretório do projeto, inicialize o projeto e instale as dependências:



### `Rodando a aplicação com o Docker:`



Na pasta app do projeto, suba o container utilizando o docker-compose.yml. Utilize o comando:



   - `docker-compose up -d`



### `npm install`



Instala as dependências.