{"id":26120551,"url":"https://github.com/thiagoaraujot/backend-nodejs","last_synced_at":"2026-04-13T04:02:29.766Z","repository":{"id":281402219,"uuid":"945166503","full_name":"ThiagoAraujot/backend-nodejs","owner":"ThiagoAraujot","description":"A simple typed and documented NodeJs API","archived":false,"fork":false,"pushed_at":"2025-03-08T20:18:46.000Z","size":17,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-08T21:33:46.698Z","etag":null,"topics":["api","api-rest","fastify","nodejs","swagger","swagger-ui","typescript","zod"],"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/ThiagoAraujot.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":"2025-03-08T20:08:41.000Z","updated_at":"2025-03-08T20:18:49.000Z","dependencies_parsed_at":"2025-03-08T21:44:11.501Z","dependency_job_id":null,"html_url":"https://github.com/ThiagoAraujot/backend-nodejs","commit_stats":null,"previous_names":["thiagoaraujot/backend-nodejs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThiagoAraujot%2Fbackend-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThiagoAraujot%2Fbackend-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThiagoAraujot%2Fbackend-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThiagoAraujot%2Fbackend-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThiagoAraujot","download_url":"https://codeload.github.com/ThiagoAraujot/backend-nodejs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242863674,"owners_count":20197672,"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","fastify","nodejs","swagger","swagger-ui","typescript","zod"],"created_at":"2025-03-10T13:43:06.504Z","updated_at":"2025-12-24T05:17:44.005Z","avatar_url":"https://github.com/ThiagoAraujot.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API Node.js com TypeScript, Zod, Fastify e Swagger\n\nEste é um projeto de uma API simples desenvolvida com **Node.js**, **TypeScript**, **Fastify**, **Zod** e **Swagger**. O objetivo principal deste projeto é demonstrar boas práticas de desenvolvimento e oferecer uma API tipada e bem documentada.\n\n## Tecnologias Utilizadas\n\n- **Node.js**: Ambiente de execução JavaScript.\n- **TypeScript**: Superset do JavaScript, adicionando tipagem estática.\n- **Fastify**: Framework web rápido e leve para Node.js.\n- **Zod**: Biblioteca para validação de tipos.\n- **Swagger**: Ferramenta para documentação de APIs.\n- **swagger-ui**: Interface visual interativa para testar a API.\n\n## Funcionalidades\n\n- API tipada com TypeScript.\n- Validação de dados com Zod.\n- Documentação interativa com Swagger UI.\n- Estrutura de pastas e código seguindo boas práticas.\n\n## Pré-requisitos\n\nAntes de rodar o projeto, você precisa ter as seguintes ferramentas instaladas em sua máquina:\n\n- **Node.js** (\u003e= 16.x)\n- **npm** ou **yarn** (gerenciador de pacotes)\n\n## Instalação\n\nSiga os passos abaixo para configurar o projeto em sua máquina local:\n\n1. Clone o repositório:\n\n   ```bash\n   git clone https://github.com/ThiagoAraujot/backend-nodejs.git\n   cd backend-nodejs\n   ```\n\n2. Instale as dependências:\n\n   Se você estiver usando **npm**:\n\n   ```bash\n   npm install\n   ```\n\n   Se preferir usar **yarn**:\n\n   ```bash\n   yarn install\n   ```\n\n## Configuração\n\nApós a instalação, o projeto já estará pronto para ser executado em sua máquina local.\n\n## Executando o Projeto\n\nPara rodar a API em modo de desenvolvimento, basta executar o seguinte comando:\n\n```bash\nnpm run dev\n```\n\nOu, se estiver usando **yarn**:\n\n```bash\nyarn dev\n```\n\nA API será iniciada e estará disponível por padrão em:\n\n```\nhttp://localhost:3333\n```\n\n## Testando a API\n\nA documentação interativa da API estará disponível através do Swagger UI em:\n\n```\nhttp://localhost:3333/docs\n```\n\nVocê pode testar as rotas diretamente através da interface do Swagger UI.\n\n## Scripts\n\n- `npm run dev` ou `yarn dev`: Executa a aplicação no modo de desenvolvimento.\n\n## Contribuindo\n\nSe você gostaria de contribuir para este projeto, siga os passos abaixo:\n\n1. Faça um fork do repositório.\n2. Crie uma branch para suas alterações: `git checkout -b minha-feature`.\n3. Faça suas modificações.\n4. Envie suas alterações para o seu fork: `git push origin minha-feature`.\n5. Abra um pull request para o repositório original.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthiagoaraujot%2Fbackend-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthiagoaraujot%2Fbackend-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthiagoaraujot%2Fbackend-nodejs/lists"}