{"id":20644914,"url":"https://github.com/dhdsouza/nodejs-rest-api","last_synced_at":"2026-04-14T05:33:32.330Z","repository":{"id":180312208,"uuid":"664853725","full_name":"dhDSouza/nodejs-rest-api","owner":"dhDSouza","description":"Esta é uma implementação simples de API Rest de usuários em Node.js. Desenvolvida como atividade do programa de estágio na Compass UOL.","archived":false,"fork":false,"pushed_at":"2025-04-22T04:51:20.000Z","size":205,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-22T06:35:40.481Z","etag":null,"topics":["api-rest","docker-compose","eslint","express","githook","husky-hooks","lintstaged","nodejs","postman-collection"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dhDSouza.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2023-07-10T22:47:19.000Z","updated_at":"2025-04-22T04:51:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"a16e8a87-1e0c-4a7f-92d6-6d40c9c20327","html_url":"https://github.com/dhDSouza/nodejs-rest-api","commit_stats":null,"previous_names":["dhdsouza/nodejs-rest-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dhDSouza/nodejs-rest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhDSouza%2Fnodejs-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhDSouza%2Fnodejs-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhDSouza%2Fnodejs-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhDSouza%2Fnodejs-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dhDSouza","download_url":"https://codeload.github.com/dhDSouza/nodejs-rest-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhDSouza%2Fnodejs-rest-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31784253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T02:24:21.117Z","status":"ssl_error","status_checked_at":"2026-04-14T02:24:20.627Z","response_time":153,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","docker-compose","eslint","express","githook","husky-hooks","lintstaged","nodejs","postman-collection"],"created_at":"2024-11-16T16:18:02.374Z","updated_at":"2026-04-14T05:33:32.308Z","avatar_url":"https://github.com/dhDSouza.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nodejs-rest-api\n\n## Sumário\n\n- [Descrição do Projeto](#descrição-do-projeto)\n- [Tecnologias Utilizadas](#tecnologias-utilizadas)\n- [Pré-requisitos](#pré-requisitos)\n- [Como Utilizar](#como-utilizar)\n- [Licença](#licença)\n\n## Descrição do Projeto\n\nEsta é uma implementação simples de API Rest de usuários em Node.js.\n\n## Tecnologias Utilizadas\n\n- [Git Hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks): Utilizado para automatizar tarefas relacionadas ao Git. Neste projeto, os Git Hooks são implementados usando as seguintes ferramentas:\n  - [Husky](https://typicode.github.io/husky/#/): Husky é uma ferramenta que permite a execução de scripts e gatilhos antes de confirmar alterações no repositório Git.\n  - [ESLint](https://eslint.org/): O ESLint é uma ferramenta de linting e formatação de código JavaScript, usada para manter um código consistente e sem erros.\n  - [lint-staged](https://github.com/okonet/lint-staged): O lint-staged é uma ferramenta usada em conjunto com o Husky e o ESLint para executar o linting e a formatação de código apenas nos arquivos modificados antes de confirmar as alterações no Git.\n\n- [NPM (Node.js Package Manager)](https://www.npmjs.com/): O NPM é o gerenciador de pacotes padrão para projetos em Node.js. Ele é usado para instalar as dependências do projeto e gerenciar scripts personalizados.\n\n- [Docker](https://www.docker.com/): O Docker é uma plataforma que permite criar e executar contêineres de aplicativos. Neste projeto, é utilizado para facilitar a configuração e execução do ambiente do MongoDB.\n\n- [Postman](https://www.postman.com/): O Postman é uma ferramenta de desenvolvimento de APIs que permite testar e documentar APIs. Neste projeto, é utilizado para importar uma coleção de solicitações HTTP pré-configuradas e facilitar os testes da API REST.\n\n## Pré-requisitos\n\nAntes de começar, verifique se você possui os seguintes pré-requisitos instalados:\n\n- Docker (opcional): [Instale o Docker](https://docs.docker.com/get-docker/)\n- Node.js: [Instale o Node.js](https://nodejs.org/)\n\n## Como Utilizar\n\nSiga as etapas abaixo para configurar e executar o projeto localmente:\n\n1. **Clone o repositório:**\n\n   ```shell\n   git clone https://github.com/dhDSouza/nodejs-rest-api.git\n   ```\n\n2. **Instale as dependências:**\n\n   ```shell\n   npm install\n   ```\n\n3. **Execute o MongoDB usando o Docker Compose:**\n\n   Certifique-se de ter o Docker instalado em sua máquina. Em seguida, execute o arquivo `mongodb-script.sh` localizado na pasta `scripts`. Isso iniciará um contêiner do MongoDB configurado de acordo com o arquivo `docker-compose.yml` fornecido. Se preferir pode simplesmente executar o seguinte comando em seu terminal na pasta `scripts` onde contém  o arquivo `docker-compose.yml`:\n\n   ```shell\n   docker-compose up -d\n   ```\n\n4. **Importe a coleção do Postman:**\n\n   Certifique-se de ter o Postman instalado em sua máquina. Em seguida, abra o Postman e importe o arquivo `nodejs-rest-api-postman-collection.json` localizado na pasta `collection`. Isso importará as solicitações HTTP pré-configuradas para testar a API REST.\n\n5. **Configure as variáveis de ambiente:**\n\n   Renomeie o arquivo `.env.example` para `.env` e preencha as informações de configuração, se necessário.\n\n   ```shell\n   DB_DIALECT=\n   DB_HOST=\n   DB_PORT=\n   DB_NAME=\n   PORT=\n   ```\n   `DB_DIALECT`: Dialeto do banco de dados utilizado. Para este projeto está sendo utilizado o MongoDB então preencha com `mongodb`.\n   `DB_HOST`: Local onde o banco de dados está hospedado, se estiver rodadando em sua máquina, como no exemplo deste projeto o valor é `localhost`.\n   `DB_PORT`: Por padrão o MongoDB utiliza a porta `27017` então preencha este campo com este valor.\n   `DB_NAME`: Nome do banco de dados, dê o nome que você preferir.\n   `PORT`: Variável resposável por definir a porta em que a aplicação irá rodar, colque a porta de sua preferência. Caso esta variável esteja vazia, por padrão a aplicação irá rodar na porta `3000`.\n\n6. **Execute a aplicação:**\n\n   ```shell\n   npm start\n   ```\n\n   Isso iniciará a aplicação e o servidor estará disponível no endereço `http://localhost:3000`.\n\n7. **Teste a API:**\n\n   Use o Postman importado para enviar solicitações HTTP à [API](./src/README.md) e testar suas funcionalidades.\n\n## Licença\n\nEste projeto está licenciado nos termos da Licença MIT. Consulte o arquivo [LICENSE](LICENSE) para obter mais informações.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhdsouza%2Fnodejs-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdhdsouza%2Fnodejs-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhdsouza%2Fnodejs-rest-api/lists"}