{"id":14967362,"url":"https://github.com/lionelsu/smith-store-api","last_synced_at":"2026-02-04T11:04:27.542Z","repository":{"id":202670884,"uuid":"706327180","full_name":"lionelsu/smith-store-api","owner":"lionelsu","description":"RESTful API developed with a focus on quality and following the TDD methodology, the API adopts a layered architecture consistent with Model, Service, Controller (MVC). This API offers operations related to products, authentication, and orders.","archived":false,"fork":false,"pushed_at":"2023-10-23T00:13:37.000Z","size":228,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T01:37:36.155Z","etag":null,"topics":["api","api-rest","chai","docker","docker-compose","mocha","mysql","nodejs","orm","postman","sequelize","sinon","typescript"],"latest_commit_sha":null,"homepage":"","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/lionelsu.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}},"created_at":"2023-10-17T18:20:13.000Z","updated_at":"2023-10-20T22:39:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"14fc1d32-d0d8-4948-b298-54396df9dee4","html_url":"https://github.com/lionelsu/smith-store-api","commit_stats":{"total_commits":12,"total_committers":3,"mean_commits":4.0,"dds":"0.16666666666666663","last_synced_commit":"ce66c615e7b44696fa6b499b4ec8944f7465ba58"},"previous_names":["lionelsu/smith-store-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lionelsu%2Fsmith-store-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lionelsu%2Fsmith-store-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lionelsu%2Fsmith-store-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lionelsu%2Fsmith-store-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lionelsu","download_url":"https://codeload.github.com/lionelsu/smith-store-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092836,"owners_count":22013294,"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","chai","docker","docker-compose","mocha","mysql","nodejs","orm","postman","sequelize","sinon","typescript"],"created_at":"2024-09-24T13:37:54.533Z","updated_at":"2026-02-04T11:04:22.505Z","avatar_url":"https://github.com/lionelsu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Este é um comentário: omitir os tópidos redundantes --\u003e\n\u003c!--  **| [Brazil](README.md) | [asdf](README_en.md) |** --\u003e\n\n# Smith Store\n\n[Documentação da API no Postman](https://documenter.getpostman.com/view/30159355/2s9YRB3Y1d)\n\nSmith Store API é uma solução completa para gerenciar uma loja de ferreiros. Esta API oferece operações relacionadas a produtos, autenticação e pedidos. Desenvolvida com foco na qualidade e seguindo a metodologia TDD (Test-Driven Development), a API adota uma arquitetura em camadas consistente com Model, Service e Controller (MSC) e o esquema do banco de dados utiliza o Diagrama de Entidade-Relacionamento (DER).\n\n## Ferramentas Utilizadas\n\n- **Tecnologias Principais:**\n  - Node.js\n  - Express.js\n  - MySQL Server\n  - Sequelize ORM\n\n- **Testes:**\n  - Mocha\n  - Chai\n  - Sinon\n\n- **Documentação:**\n  - Postman\n\n## Pré-Requisitos\n\nNode versão igual ou superio a 16.14.0 LTS:\n\n- [Node.js](https://nodejs.org/en/)\n\nDocker e Docker Compose:\n\n- [Docker \u0026 Docker Compose](https://docs.docker.com/compose/)\n\n\u003c!-- ## Features --\u003e\n## Instalação\n\n\u003cdetails\u003e\n\n\u003csummary\u003eCom Docker\u003c/summary\u003e\n\n1. Clonar o Repositório\n\n    Primeiro, copie ou clone este repositório para o seu sistema local usando o Git:\n\n    ```bash\n    git clone git@github.com:lionelsu/smith-store-api.git \u0026\u0026 cd smith-store-api\n    ```\n\n2. Iniciar o Contêiner Docker\n\n    Utilize o Docker Compose para iniciar o contêiner do Smith Store API:\n\n    ```bash\n    docker compose up -d\n    ```\n\n3. Popular o Banco de Dados\n\n    Utilize o Docker para popular o banco de dados:\n\n    ```bash\n    docker exec smithstore_api npm run db:reset\n    ```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eLocalmente com NodeJs\u003c/summary\u003e\n\n1. Clonar o Repositório\n\n    Primeiro, copie ou clone este repositório para o seu sistema local usando o Git:\n\n    ```bash\n    git clone git@github.com:lionelsu/smith-store-api.git \u0026\u0026 cd smith-store-api\n    ```\n\n2. Instalar as Dependências\n\n    Em seguida, instale as dependências do projeto usando o `npm`:\n\n    ```bash\n    npm install\n    ```\n\n3. Popular o Banco de Dados\n\n    ```bash\n    npm run db:reset\n    ```\n\n4. Iniciar o Servidor\n\n    Inicie o servidor para executar a API:\n\n    ```bash\n    npm run dev\n    ```\n\n\u003c/details\u003e\n\n## Uso\n\nPara interagir com o Smith Store, você pode usar os seguintes comandos:\n\nVisualização de Logs\n\n```bash\ndocker logs -n 10 -f smithstore_api\n```\n\nLinha de Comando Interativa, usada para **[testar](#testes)** a aplicação\n\n```bash\ndocker exec -it smithstore_api bash\n```\n\nResetar o Banco de Dados (deve ser executado dentro da **[linha de comando interativa](#uso)**)\n\n```bash\nnpm run db:reset\n```\n\n## Rotas da API\n\n**Produtos:**\n\n- **`POST /products`**: Cadastra um novo produto.\n- **`GET /products`**: Retorna todos os produtos cadastrados.\n\n**Pedidos:**\n\n- **`POST /orders`**: Cadastra um novo pedido.\n- **`GET /orders`**: Retorna todos os pedidos cadastradas.\n\n## Testes\n\n- Dentro da **[linha de comando interativa](#uso)**, você pode executar os seguintes testes:\n\n  - Testes Unitários:\n\n  ```bash\n  npm run test:mocha\n  ```\n\n  - Cobertura de Testes:\n\n  ```bash\n  npm run test:coverage\n  ```\n\n## Habilidades desenvolvidas\n\nDesenvolvi minha aplicação usando `Node.js` com `Express.js` como base. Isso me permitiu criar facilmente endpoints `HTTP` para atender às necessidades do sistema.\n\nEscolhi usar o banco de dados `MySQL Server` para armazenar informações sobre produtos, vendas e outros aspectos importantes do sistema.\n\nA regra de negocio foi implementada utilizando o `Sequelize ORM` para facilitar a interação com o banco de dados e os algorithmos de classificação foram implementados utilizando o `JavaScript` em uma camada especifica para isso.\n\nPara garantir a qualidade do código, realizei testes rigorosos com `Mocha`, `Chai` e `Sinon`. Esses testes verificaram minuciosamente os endpoints, serviços e funções para garantir que tudo funcione corretamente.\n\nTambém criei uma Documentação no `Postman` para facilitar os testes e interações com a `API`.\n\nCom essas etapas concluídas, estou confiante na entrega de uma `API` sólida e funcional, pronta para atender às necessidades dos usuários.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flionelsu%2Fsmith-store-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flionelsu%2Fsmith-store-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flionelsu%2Fsmith-store-api/lists"}