Update README.md

README.md

@@ -1,13 +1,67 @@
-# :construction: README customizado em construção ! :construction:
-<!-- Olá, Tryber!
-Esse é apenas um arquivo inicial para o README do seu projeto no qual você pode customizar e reutilizar todas as vezes que for executar o trybe-publisher.
-
-Para deixá-lo com a sua cara, basta alterar o seguinte arquivo da sua máquina: ~/.student-repo-publisher/custom/_NEW_README.md
-
-É essencial que você preencha esse documento por conta própria, ok?
-Não deixe de usar nossas dicas de escrita de README de projetos, e deixe sua criatividade brilhar!
-:warning: IMPORTANTE: você precisa deixar nítido:
-- quais arquivos/pastas foram desenvolvidos por você; 
-- quais arquivos/pastas foram desenvolvidos por outra pessoa estudante;
-- quais arquivos/pastas foram desenvolvidos pela Trybe.
--->
+# 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
+
+<div>
+    <img src="https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white" alt="TypeScript"/>
+    <img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white" alt="NodeJS"/>
+    <img src="https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white" alt="Express"/>
+    <img src="https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white" alt="MongoDB" />
+    <img src="https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=white" alt="Swagger" />
+      <img src='https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white' alt='ESlint' />
+    <img src="https://img.shields.io/badge/Mocha-8D6748?style=for-the-badge&logo=Mocha&logoColor=white" alt="Mocha" />
+    <img src="https://img.shields.io/badge/chai-A30701?style=for-the-badge&logo=chai&logoColor=white" alt="Chai" />
+</div>
+
+<br>
+
+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/)
+- [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/)
+
+
+## ⚙️ Execução
+
+Para executar a aplicação inicie realizando o clone deste repositório com o comando abaixo.
+
+    git clone git@github.com:GabrielaMoura25/car-shop.git
+
+Navegue até a raíz do projeto.
+
+    cd car-shop
+
+Execute o comando para instalar as dependencias do projetos.
+
+    npm install
+
+
+Rode os testes da aplicação usando o seguinte comando
+
+    npm run test:mocha ou npm run test:coverage
+
+
+---
+
+Desenvolvido por [Gabriela Moura](https://www.linkedin.com/in/gabriela-daniel-moura/), © 2023.