{"id":18325962,"url":"https://github.com/adolligit/car-shop","last_synced_at":"2026-04-12T13:46:20.451Z","repository":{"id":112265891,"uuid":"567522183","full_name":"Adolligit/car-shop","owner":"Adolligit","description":"Car Shop é um projeto idealizado pela escola @Tryber e desenvolvido pelos alunos (como eu). É uma API REST desenvolvida em TypeScript que utiliza o ODM Mongoose para consultar o banco de dados não relacional MongoDB.","archived":false,"fork":false,"pushed_at":"2024-07-14T20:07:51.000Z","size":400,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-15T09:44:17.972Z","etag":null,"topics":["api","api-rest","backend","docker","expressjs","mongodb","nodejs","oop","oop-principles","openapi-documentation","openapi3","solid","typescript"],"latest_commit_sha":null,"homepage":"https://www.linkedin.com/in/adelson-lima","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Adolligit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-18T00:58:04.000Z","updated_at":"2024-07-14T20:07:54.000Z","dependencies_parsed_at":"2023-10-14T22:41:05.310Z","dependency_job_id":null,"html_url":"https://github.com/Adolligit/car-shop","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adolligit%2Fcar-shop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adolligit%2Fcar-shop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adolligit%2Fcar-shop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adolligit%2Fcar-shop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Adolligit","download_url":"https://codeload.github.com/Adolligit/car-shop/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248064447,"owners_count":21041857,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-rest","backend","docker","expressjs","mongodb","nodejs","oop","oop-principles","openapi-documentation","openapi3","solid","typescript"],"created_at":"2024-11-05T19:05:08.568Z","updated_at":"2026-04-12T13:46:20.446Z","avatar_url":"https://github.com/Adolligit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eCar Shop\u003c/h1\u003e\n\nCar Shop é uma *API Rest* que consulta o banco de dados não relacional MongoDB através do *ODM* Mongoose.\n\nEsta API é um *CRUD* feito com os princípios da *Programação Orientada á Objetos (POO)* e seu propósito é simular o gerenciamento de um sistema de uma concessionária de veículos.\n\nEste projeto foi desenvolvido em **Node.js + Express.js + TypeScript**, utilizando **Mongoose.js** para comunicação com o banco de dados **MongoDB**. Além disso, foram realizados testes nas camadas *Model, Controller e Service* com **Mocha + Chai + Sinon**.\n\n## Como eu faço para executar este projeto?\nPrimeiro de tudo, clone o projeto na sua máquina local e entre na pasta do projeto:\n```bash\ngit clone git@github.com:Adolligit/car-shop.git \u0026\u0026 cd ./car-shop\n```\nDepois instale as dependências:\n```bash\nnpm install\n```\n### Instalação\n🚨 As versões descritas nas instalações são **fortemente recomendadas**. No entanto, caso queira tentar em uma versão diferente, considere a possível aparição de erros durante a execução do projeto.\n\nEscolha abaixo um tipo de instalação:\n\u003cdetails\u003e\n  \u003csummary\u003eInstalar com Docker 🐳\u003c/summary\u003e\n\u003c/br\u003e\u003cb\u003eRequisitos\u003c/b\u003e\n\u003c/br\u003eVocê deve possuir as seguintes ferramentas:\n\u003cul\u003e\n    \u003cli\u003eDocker: v24.0.2\u003c/li\u003e\n    \u003cli\u003eDocker Compose: v2.19.0\u003c/li\u003e\n\u003c/ul\u003e\n\n  ⚠️ Se você estiver usando **Linux**, desative o **MongoDB** localmente para evitar conflitos de porta:\n  ```bash\n  systemctl stop mongod\n  ```\n\n\u003chr\u003e\n\n  1. Crie e inicie os contêiners:\n  ```bash\n  docker compose up -d\n  ```\n  2. Entre no contêiner da aplicação:\n  ```bash\n  docker exec -it car_shop bash\n  ```\n  ---\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eInstalar localmente 💻\u003c/summary\u003e\n\u003c/br\u003e\u003cb\u003eRequisitos\u003c/b\u003e\n\u003c/br\u003eVocê deve possuir as seguintes ferramentas:\n\u003cul\u003e\n    \u003cli\u003enpm: v9.6.7\u003c/li\u003e\n    \u003cli\u003eNode: v20.3\u003c/li\u003e\n    \u003cli\u003eMongoDB: v6.0\u003c/li\u003e\n\u003c/ul\u003e\n\nSe você usa **Linux**, verifique se o serviço do **MongoDB** esta ativo: \n```bash\nsystemctl status mongod\n```\nCaso esteja desativado, substitua **status** por **start** no comando acima.\n\u003chr\u003e\n\n1. Crie o arquivo \u003cb\u003e.env\u003c/b\u003e na pasta raiz\n```bash\ntouch .env\n```\n\n2. Copie e cole as informações a seguir:\n\n```bash\n# MongoDB\nMDB_URI=\nMDB_HOST=127.0.0.1\nMDB_PORT=27017\nMDB_NAME=CarShop\n\n# API\nAPI_PORT=3001\n```\n\u003e 🗣️(Dica): Você pode conectar a aplicação com um banco remoto, adicionado a URI do banco em **MDB_URI**.\n\n\u003chr\u003e\n\u003c/details\u003e\n\n### Execução\n⚠️ Os comandos a seguir podem ser executados dentro do Container ou localmente.\n\nIniciar o projeto em modo de desenvolvimento (com **nodemon**):\n```bash\nnpm run dev\n```\n\nExecutar a cobertura de testes:\n```bash\nnpm run test:dev\n```\n\nExecuta os testes e depois criar a pasta **./coverage** que contém um relatório:\n```bash\nnpm run test:coverage\n```\n\u003e 🗣️(Dica): Utilizando a extensão **Live Server** no Visual Studio Code, você poderá visualizar a página com o relatório navegando até pasta criada e abrindo o arquivo **index.html** no navegador.\n\nExecutar o **ESLint** para verificar os erros do código estático:\n```bash\nnpm run lint\n```\n\n## Testando o CRUD\nVocê pode utilizar qualquer Client API para testar o Car Shop, contudo, eu disponibilizei a documentação com OpenAPI (Swagger) para que você saiba quais rotas existem dentro do projeto e como testa-las.\n\nDesta forma, quando a API estiver em execução, você poderá visitar http://127.0.0.1:3001/v1/docs/ e visualizar a página da documentação e testar a API.\n\n\u003cimg align=\"center\" alt=\"NodeJs\" src=\"https://raw.githubusercontent.com/Adolligit/car-shop/main/img/ss1.png\"\u003e\n\n\u003e 🗣️(Dica): O banco de dados não esta populado. Portanto é uma boa ideia começar cadastrando os dados.\n\n##  Linguagens e ferramentas:\n\u003cdiv\u003e\n    \u003ca href=\"https://nodejs.org/en/\"\u003e\u003cimg align=\"center\" alt=\"NodeJs\" height=\"40\" width=\"50\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/nodejs/nodejs-original.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://expressjs.com/pt-br/\"\u003e\u003cimg align=\"center\" alt=\"Express\" height=\"40\" width=\"50\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/express/express-original.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.typescriptlang.org/\"\u003e\u003cimg align=\"center\" alt=\"TypeScript\" height=\"40\" width=\"50\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/typescript/typescript-original.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://mongoosejs.com/\"\u003e\u003cimg align=\"center\" alt=\"Mongoose\" height=\"40\" width=\"50\" src=\"https://avatars.githubusercontent.com/u/7552965?s=280\u0026v=4\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.mongodb.com/\"\u003e\u003cimg align=\"center\" alt=\"Mongo\" height=\"40\" width=\"50\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/mongodb/mongodb-plain-wordmark.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://mochajs.org/\"\u003e\u003cimg align=\"center\" alt=\"Mocha\" height=\"40\" width=\"50\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/mocha/mocha-plain.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.chaijs.com/\"\u003e\u003cimg align=\"center\" alt=\"Chai\" height=\"40\" width=\"50\" src=\"https://cdn.icon-icons.com/icons2/2699/PNG/512/chaijs_logo_icon_168435.png\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://sinonjs.org/\"\u003e\u003cimg align=\"center\" alt=\"Sinon\" height=\"40\" width=\"50\" src=\"https://avatars.githubusercontent.com/u/6570253?s=280\u0026v=4\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadolligit%2Fcar-shop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadolligit%2Fcar-shop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadolligit%2Fcar-shop/lists"}