{"id":15170636,"url":"https://github.com/adolligit/store-manager","last_synced_at":"2026-02-03T18:02:14.725Z","repository":{"id":64135071,"uuid":"572720261","full_name":"Adolligit/store-manager","owner":"Adolligit","description":"Store Manager é uma API Rest feita em NodeJS + ExpressJS, que faz consultas diretamente no banco de dados MySQL através query's no 'hardcoded'. O projeto foi idealizado pela escola de programação @tryber e realizado pelos alunos, como eu. Seja muito bem-vindo ao repositório!","archived":false,"fork":false,"pushed_at":"2023-08-20T04:49:00.000Z","size":3846,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-17T01:41:15.232Z","etag":null,"topics":["api-rest","architecture-components","docker","docker-compose","docker-image","dockerfile","express-api","express-js","express-rescue","expressjs","mocha-chai","mocha-tests","mochajs","mysql","mysql-database","mysql2","nodejs","swagger-ui","unit-testing","unittest"],"latest_commit_sha":null,"homepage":"https://www.linkedin.com/in/adelson-lima/","language":"JavaScript","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-30T22:13:06.000Z","updated_at":"2023-07-09T18:34:11.000Z","dependencies_parsed_at":"2024-08-23T14:34:31.227Z","dependency_job_id":null,"html_url":"https://github.com/Adolligit/store-manager","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%2Fstore-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adolligit%2Fstore-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adolligit%2Fstore-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adolligit%2Fstore-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Adolligit","download_url":"https://codeload.github.com/Adolligit/store-manager/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254095016,"owners_count":22013677,"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-rest","architecture-components","docker","docker-compose","docker-image","dockerfile","express-api","express-js","express-rescue","expressjs","mocha-chai","mocha-tests","mochajs","mysql","mysql-database","mysql2","nodejs","swagger-ui","unit-testing","unittest"],"created_at":"2024-09-27T08:20:21.899Z","updated_at":"2026-02-03T18:02:14.720Z","avatar_url":"https://github.com/Adolligit.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eStore Manager\u003c/h1\u003e\n\n\u003cp align=\"justify\"\u003e\n  Store Manager é uma API Rest que busca simular o gerenciamento de dados de uma loja.\n\u003c/p\u003e\n\u003cp align=\"justify\"\u003e\n  Esta API foi construída em \u003cb\u003eNode.js\u003c/b\u003e junto ao \u003cb\u003eExpress.js\u003c/b\u003e sendo que sua cobertura de teste unitários foi realizada em \u003cb\u003eMocha\u003c/b\u003e, \u003cb\u003eChai\u003c/b\u003e e \u003cb\u003eSinon\u003c/b\u003e. Para consultar os dados no banco, foram feitas query's diretamente no código (\u003cb\u003e\"hardcoded\"\u003c/b\u003e), sendo que elas e a estrutura do banco de dados, foram criados em MySQL.\n\u003c/p\u003e\n\n## Como eu faço para executar este projeto?\n\nAntes de mais nada, primeiro faça o clone e navegue até a pasta do projeto:\n\n```bash\ngit clone git@github.com:Adolligit/store-manager.git \u0026\u0026 cd store-manager/\n```\n\n### Instalação\n\n\u003cp align=\"justify\"\u003e\n🚨 É \u003cb\u003ecrucial\u003c/b\u003e que você já tenha em sua máquina as ferramentas citadas em cada tipo de instalação, com a correta versão ou superior.\n\nEscolha uma das instalações a seguir:\n\u003c/p\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eInstalar com Docker 🐳\u003c/summary\u003e\n  \u003cb\u003eRequisitos\u003c/b\u003e\n  \u003cbr\u003eVocê deve possuir as seguintes ferramentas:\n\u003cul\u003e\n    \u003cli\u003eDocker: v20.1\u003c/li\u003e\n    \u003cli\u003eDocker Compose: v1.29\u003c/li\u003e\n\u003c/ul\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 store_manager bash\n  ```\n  ---\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eInstalar localmente 💻\u003c/summary\u003e\n  \u003cb\u003eRequisitos\u003c/b\u003e\n  \u003cbr\u003eVocê deve possuir as seguintes ferramentas:\n\u003cul\u003e\n    \u003cli\u003eNode.js: v16\u003c/li\u003e\n    \u003cli\u003enpm: v8.19\u003c/li\u003e\n    \u003cli\u003eMySQL: v8\u003c/li\u003e\n\u003c/ul\u003e\n\n  1. Crie um arquivo **.env** na pasta raiz e declare as variáveis de ambiente:\n   ```bash\n   touch .env\n   ```\n   2. Abra o arquivo **.env** e então copie e cole as informações a seguir:\n      ```bash\n      # db\n      MYSQL_HOST=127.0.0.1\n      MYSQL_PORT=3306\n      MYSQL_USER=\n      MYSQL_PASSWORD=\n      MYSQL_DATABASE=StoreManager\n\n      # app\n      APP_PORT=3000\n      ```\n  3. No arquivo **.env**, informe seus dados de acesso ao banco de dados MySQL nas chaves: **MYSQL_USER** e **MYSQL_PASSWORD** (lembre-se de salvar o arquivo).\n  ---\n\u003c/details\u003e\n\n### Execução\n\nInstalar as dependências do projeto:\n  ```bash\nnpm install\n  ```\nCriar as tabelas no banco de dados MySQL:\n```bash\nnpm run migration\n```\nPopular o banco de dados:\n```bash\nnpm run seed\n```\nIniciar o projeto:\n```bash\nnpm start\n```\nInciar o projeto em modo de desenvolvimento (nodemon):\n```bash\nnpm run dev\n```\nExecutar os a cobertura de testes:\n```bash\nnpm run test:mocha\n```\nExecutar o **ESLint** para verificar os erros do código estático:\n```bash\nnpm run lint\n```\nRecriar o banco de dados já populado:\n```bash\nnpm run reset\n```\n## Quais são as rotas desta API?\nDeixei uma documentação feita com [Swagger UI](https://swagger.io/tools/swagger-ui/) para facilitar e lhe orientar no uso da API. Você pode acessa-la em [http://127.0.0.1:3000/v1/docs/](http://127.0.0.1:3000/v1/docs/).\n\u003cimg align=\"center\" alt=\"gif de demonstração de uso\" src=\"https://raw.githubusercontent.com/Adolligit/store-manager/main/img/1.gif\"\u003e\n\n## Como estão organizadas as tabelas?\nApesar de ser uma API Rest bem simples, eu fiz esse DER para facilitar a visualização da estrutura do banco de dados. Desta forma fica mais fácil saber como esta o relacionamento entre as entidades. Confira:\n\u003cimg align=\"center\" alt=\"DER\" src=\"https://raw.githubusercontent.com/Adolligit/store-manager/main/img/1ssdb.png\"\u003e\n\n## Erros comuns\nDescrevo neste tópico alguns possíveis erros que você pode estar enfrentando durante a instalação ou execução desta API.\n\nUma das opções descritas no erro poderá resolver o problema que você esta enfrentando. Contudo, caso ainda permaneça com dificuldade para testar a API, me envie um e-mail: adelson.onod@gmail.com.\n\nAntes de prosseguir, por favor confirme que:\n- Docker 🐳\n  - Você tem instalado em sua máquina o Docker e o Docker Compose nas versões mínimas exigidas.\n  - Verificou que a Docker Engine esta funcionando corretamente na sua máquina.\n- Localmente 💻\n  - Você tem instalado em minha máquina o MySQL, Node.js e NPM nas versões mínimas exigidas.\n  - Verificou que o MySQL esta funcionando corretamente na sua máquina.\n\n\n### Possíveis erros de instalação e execução:\n\u003cdetails\u003e\n  \u003csummary\u003eErro ao subir os contêiners: \u003cb\u003edocker compose up -d\u003c/b\u003e\u003c/summary\u003e\n  \u003cimg align=\"center\" alt=\"docker-error\" src=\"https://raw.githubusercontent.com/Adolligit/store-manager/main/img/2sse.png\"\u003e\n\n  Você esta tentando subir os contêiners do Docker porém uma das portas já está em uso. Pode ser o banco de dados ou a API com este erro.\n\n  As portas descritas para uso no **docker-compose.yml** são:\n  - API: **3000**\n  - Banco: **3307**\n\n  Para resolver isso, você pode:\n  - Desativar os programas que estão fazendo uso das portas; OU\n  - Alterar o valor para as portas no arquivo **docker-compose.yml**, em:\n    - **MYSQL_PORT**;\n    - **APP_PORT** e;\n    - **ports** (para db e node): as portas da máquina local são descritas no lado esquerdo.\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eErro durante a instalação de dependências: \u003cb\u003enpm install\u003c/b\u003e\u003c/summary\u003e\n  \u003cimg align=\"center\" alt=\"npm-install\" src=\"https://raw.githubusercontent.com/Adolligit/store-manager/main/img/3sse.png\"\u003e\n\n  O NPM não encontrou o arquivo 'package.json' na pasta de execução. Você pode ter excluído sem querer ou pode estar executando o comando fora da pasta do projeto.\n\n  Para resolver isso, você pode:\n  - Verificar se esta na pasta do projeto. Se não tiver, basta entrar e executar o comando `npm install`; OU\n  - Baixar o `package-lock.json` e o `package.json`, depois colar na pasta do projeto:\n    - https://github.com/Adolligit/store-manager/blob/main/package-lock.json;\n    - https://github.com/Adolligit/store-manager/blob/main/package.json.\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eErro ao tentar popular o banco de dados ou ele não foi reconhecido\u003c/summary\u003e\n  \u003cimg align=\"center\" alt=\"npm-seed\" src=\"https://raw.githubusercontent.com/Adolligit/store-manager/main/img/4sse.png\"\u003e\n\n  Este erro significa que não há criado o banco de dados 'StoreManager'. \n\n  Para resolver isso você deve:\n  - Executar o comando `npm run migration` (acho que você esqueceu disso lá nos comando acima).\n\u003c/details\u003e\n\n## Linguagens e ferramentas:\n\u003cdiv\u003e\n    \u003ca href=\"https://swagger.io/tools/swagger-ui/\"\u003e\u003cimg align=\"center\" alt=\"NodeJs\" height=\"45\" width=\"45\" src=\"https://camo.githubusercontent.com/96e43701d83561899724a89d71187445b7b8f4fe84518a3ea5bec8f85bd207bf/68747470733a2f2f63646e2e737667706f726e2e636f6d2f6c6f676f732f737761676765722e737667\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://nodejs.org/en/\"\u003e\u003cimg align=\"center\" alt=\"NodeJs\" height=\"45\" width=\"45\" 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=\"45\" width=\"45\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/express/express-original.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://mochajs.org/\"\u003e\u003cimg align=\"center\" alt=\"Mocha\" height=\"45\" width=\"45\" 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=\"45\" width=\"45\" 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=\"45\" width=\"45\" src=\"https://avatars.githubusercontent.com/u/6570253?s=280\u0026v=4\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://dev.mysql.com/doc/\"\u003e\u003cimg align=\"center\" alt=\"NodeJs\" height=\"45\" width=\"66\" src=\"https://upload.wikimedia.org/wikipedia/labs/8/8e/Mysql_logo.png\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://docs.docker.com/\"\u003e\u003cimg align=\"center\" alt=\"NodeJs\" height=\"45\" width=\"45\" src=\"https://www.docker.com/wp-content/uploads/2022/03/vertical-logo-monochromatic.png\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadolligit%2Fstore-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadolligit%2Fstore-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadolligit%2Fstore-manager/lists"}