{"id":15061641,"url":"https://github.com/vitinho163/in.orbit-backend","last_synced_at":"2026-01-03T00:04:34.799Z","repository":{"id":256635270,"uuid":"855506153","full_name":"Vitinho163/In.orbit-backend","owner":"Vitinho163","description":"Back-end da aplicação In.orbit, um gerenciador de metas!","archived":false,"fork":false,"pushed_at":"2024-09-13T02:03:31.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-15T22:43:12.572Z","etag":null,"topics":["biome","dayjs","docker","drizzle-orm","fastify","nodejs","postgresql","zod"],"latest_commit_sha":null,"homepage":"https://in-orbit-backend.onrender.com","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/Vitinho163.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":"2024-09-11T01:23:12.000Z","updated_at":"2024-09-13T02:03:34.000Z","dependencies_parsed_at":"2025-01-22T11:41:28.950Z","dependency_job_id":"9e612b48-8c7a-45b4-994d-a088528b04cf","html_url":"https://github.com/Vitinho163/In.orbit-backend","commit_stats":null,"previous_names":["vitinho163/in.orbit-backend"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vitinho163%2FIn.orbit-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vitinho163%2FIn.orbit-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vitinho163%2FIn.orbit-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vitinho163%2FIn.orbit-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Vitinho163","download_url":"https://codeload.github.com/Vitinho163/In.orbit-backend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243801609,"owners_count":20350106,"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":["biome","dayjs","docker","drizzle-orm","fastify","nodejs","postgresql","zod"],"created_at":"2024-09-24T23:23:02.221Z","updated_at":"2026-01-03T00:04:34.761Z","avatar_url":"https://github.com/Vitinho163.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eIn.orbit: Back-End\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"#english\"\u003eEnglish\u003c/a\u003e |\n  \u003ca href=\"#portugues\"\u003ePortuguês\u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n# English \u003ca name=\"english\"\u003e\u003c/a\u003e\n\nIn.orbit - Back-End is a **Node.js** application developed as part of Rocketseat's NLW Pocket event. It's a goal manager where users can create weekly goals, track progress, and view a summary of completed goals with a progress bar.\n\n## Summary\n\n- [Technologies Used](#technologies-used-en)\n- [Project Structure](#project_structure_en)\n- [Installation](#installation-en)\n- [Deploy](#deploy-en)\n- [Author](#author-en)\n\n## 🚀 Technologies Used \u003ca name=\"technologies-used-en\"\u003e\u003c/a\u003e\n\n- **[Node.js](https://nodejs.org/)**: JavaScript runtime built on Chrome's V8 engine.\n- **[Fastify](https://www.fastify.io/)**: Fast and low overhead web framework for Node.js.\n- **[@paralleldrive/cuid2](https://github.com/paralleldrive/cuid2)**: Secure, collision-resistant IDs for applications.\n- **[Day.js](https://day.js.org/)**: Fast and lightweight date library for JavaScript.\n- **[PostgreSQL](https://www.postgresql.org/)**: Powerful, open-source object-relational database system.\n- **[Zod](https://zod.dev/)**: TypeScript-first schema declaration and validation library.\n- **[Drizzle ORM](https://github.com/drizzle-team/drizzle-orm)**: Lightweight TypeScript ORM.\n- **[Biome](https://biomejs.dev/)**: Tool for formatting and linting code.\n- **[@fastify/static](https://github.com/fastify/fastify-static)**: Fastify plugin for serving static files.\n- **[@scalar/fastify-api-reference](https://github.com/scalar/scalar/tree/main/packages/fastify-api-reference#readme)**: Fastify plugin for API documentation.\n\n## 📁 Structure of the project \u003ca name=\"project_structure_en\"\u003e\u003c/a\u003e\n\n```\n├── src: directory containing application source files\n\n│ ├── db: directory containing database connection, schema, and seed files.\n\n│ ├── documentation: directory containing API documentation files (Insomnia and Swagger).\n\n│ ├── functions: directory containing exported function files (create-goal-completion, create-goal, get-week-pending-goals, get-week-summary).\n\n│ ├── http: directory containing routes and server initialization files.\n\n│ | ├── routes: directory with all the application routes.\n\n| | └── server.ts: file initializing the application.\n\n│ ├── env.ts: file validating environment variables with Zod.\n\n├── .env.example: example file for environment variables.\n```\n\n## 🛠️ Installation \u003ca name=\"installation-en\"\u003e\u003c/a\u003e\n\n1. Clone the repository or download the ZIP file from the repository.\n```bash\ngit clone https://github.com/Vitinho163/In.orbit-backend.git\n```\n\n2. Install dependencies:\n```bash\nnpm install\n```\n\n3. Rename the `.env.example` file to `.env` and fill in the information:\n```bash\nDATABASE_URL=\"postgresql://docker@localhost:5432/inorbit\"\n```\n\n4. Run the migration:\n```bash\nnpx drizzle-kit migrate\n```\n\n5. Start the server:\n```bash\nnpm run dev\n```\n\n## 💻 Deploy \u003ca name=\"deploy-en\"\u003e\u003c/a\u003e\n\nThe back-end of this project is hosted on Render and can be accessed at:\n```\nhttps://in-orbit-backend.onrender.com/\n```\n\n\u003eNote: The application may take some time to respond if it's been idle due to Render's free tier limitations.\n\n\u003cdiv align=\"center\" name=\"author-en\"\u003e\n  \u003ch4\u003eCreated with ❤️ by \u003ca href=\"https://github.com/Vitinho163\"\u003eJoão Victor\u003c/a\u003e\u003c/h4\u003e\n\u003c/div\u003e\n\n---\n\n# Português \u003ca name=\"portugues\"\u003e\u003c/a\u003e\n\nIn.orbit - Back-End é uma aplicação **Node.js** desenvolvida durante a NLW Pocket da Rocketseat. É um gerenciador de metas onde os usuários podem cadastrar metas semanais, acompanhar o progresso e visualizar o histórico de metas realizadas com uma barra de progresso.\n\n## Sumário\n\n- [Tecnologias Utilizadas](#tecnologias-usadas-pt)\n- [Estrutura do Projeto](#estrutura-do-projeto-pt)\n- [Instalação](#instalacao-pt)\n- [Deploy](#deploy-pt)\n- [Autor](#autor-pt)\n\n## 🚀 Tecnologias Utilizadas \u003ca name=\"tecnologias-usadas-pt\"\u003e\u003c/a\u003e\n\n- **[Node.js](https://nodejs.org/)**: Ambiente de execução JavaScript baseado no motor V8 do Chrome.\n- **[Fastify](https://www.fastify.io/)**: Framework web rápido e leve para Node.js.\n- **[@paralleldrive/cuid2](https://github.com/paralleldrive/cuid2)**: Geração de IDs seguros e resistentes a colisões.\n- **[Day.js](https://day.js.org/)**: Biblioteca de datas rápida e leve para JavaScript.\n- **[PostgreSQL](https://www.postgresql.org/)**: Sistema de banco de dados relacional de código aberto.\n- **[Zod](https://zod.dev/)**: Biblioteca de validação de esquemas baseada em TypeScript.\n- **[Drizzle ORM](https://github.com/drizzle-team/drizzle-orm)**: ORM leve para TypeScript.\n- **[Biome](https://biomejs.dev/)**: Ferramenta para formatação e linting de código.\n- **[@fastify/static](https://github.com/fastify/fastify-static)**: Plugin Fastify para servir arquivos estáticos.\n-**[@scalar/fastify-api-reference](https://github.com/scalar/scalar/tree/main/packages/fastify-api-reference#readme)**: Plugin Fastify para documentação de API.\n\n## 📁 Estrutura do Projeto \u003ca name=\"estrutura-do-projeto-pt\"\u003e\u003c/a\u003e\n\n```\n├── src: diretório contendo os arquivos da aplicação\n\n│ ├── db: diretório contendo a conexão com o banco de dados, schema e seed.\n\n│ ├── documentation: diretório contendo arquivos de documentação da API (Insomnia e Swagger).\n\n│ ├── functions: diretório com os arquivos das funções exportadas (create-goal-completion, create-goal, get-week-pending-goals, get-week-summary).\n\n│ ├── http: diretório com as rotas e arquivos de inicialização da aplicação.\n\n│ | ├── routes: diretório contendo as rotas da aplicação.\n\n| | └── server.ts: arquivo de inicialização da aplicação.\n\n│ ├── env.ts: arquivo validando as variáveis de ambiente com Zod.\n\n├── .env.example: arquivo de exemplo para variáveis de ambiente.\n```\n\n## 🛠️ Instalação \u003ca name=\"instalacao-pt\"\u003e\u003c/a\u003e\n\n1. Clone o repositório ou faça o download do arquivo ZIP:\n```bash\ngit clone https://github.com/Vitinho163/In.orbit-backend.git\n```\n\n2. Instale as dependências:\n```bash\nnpm install\n```\n\n3. Renomeie o arquivo `.env.example` para `.env` e preencha as informações:\n```bash\nDATABASE_URL=\"postgresql://docker@localhost:5432/inorbit\"\n```\n\n4. Execute a migração:\n```bash\nnpx drizzle-kit migrate\n```\n\n5. Inicie o servidor:\n```bash\nnpm run dev\n```\n\n## 💻 Deploy \u003ca name=\"deploy-pt\"\u003e\u003c/a\u003e\n\nO back-end deste projeto está hospedado na Render e pode ser acessado em:\n```\nhttps://in-orbit-backend.onrender.com/\n```\n\n\u003eNota: A aplicação pode demorar para responder se estiver inativa devido às limitações do plano gratuito da Render.\n\n\u003cdiv align=\"center\" name=\"autor-pt\"\u003e\n  \u003ch4\u003eCriado com ❤️ por \u003ca href=\"https://github.com/Vitinho163\"\u003eJoão Victor\u003c/a\u003e\u003c/h4\u003e\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitinho163%2Fin.orbit-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitinho163%2Fin.orbit-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitinho163%2Fin.orbit-backend/lists"}