{"id":15568891,"url":"https://github.com/nsdonato/planetas_api","last_synced_at":"2025-04-24T00:06:53.143Z","repository":{"id":63370598,"uuid":"525169529","full_name":"nsdonato/planetas_api","owner":"nsdonato","description":"🔌 Back de: Vamosacodearplanetas 🌎 | Simulación de trabajo en equipo con la comunidad de Twitch https://twitch.tv/vamoacodear y Discord https://discord.io/vamoacodear","archived":false,"fork":false,"pushed_at":"2023-08-05T21:52:52.000Z","size":696,"stargazers_count":7,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-24T00:06:46.352Z","etag":null,"topics":["eslint","express","husky","node","prettier","render","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/nsdonato.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-08-15T23:33:55.000Z","updated_at":"2023-08-05T15:41:59.000Z","dependencies_parsed_at":"2024-10-02T17:21:27.449Z","dependency_job_id":"de5926cf-b8a8-4dda-b6cf-b213ae392560","html_url":"https://github.com/nsdonato/planetas_api","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/nsdonato%2Fplanetas_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nsdonato%2Fplanetas_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nsdonato%2Fplanetas_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nsdonato%2Fplanetas_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nsdonato","download_url":"https://codeload.github.com/nsdonato/planetas_api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250535103,"owners_count":21446508,"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":["eslint","express","husky","node","prettier","render","typescript"],"created_at":"2024-10-02T17:21:20.194Z","updated_at":"2025-04-24T00:06:53.098Z","avatar_url":"https://github.com/nsdonato.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Proyecto: planetas_api 🌏\n\n👋🏻 Bienvenidx al Proyecto de [FrontEnd-Mentor](https://www.frontendmentor.io/challenges/planets-fact-site-gazqN8w_f) desarrollada por la comunidad de Discord de [👩🏻‍💻 vamoacodear 👩🏻‍💻](https://www.twitch.tv/vamoacodear)! En este caso la parte del BackEnd.\n\n# Descripción\n\nEn este reto, construiremos una API para que sea consumido por el front del proyecto [vamosacodearplanetas](https://github.com/nsdonato/vamosacodearplanetas). 🎨 Lucirá muy bien en tu portfolio.\n\nLo que intetamos hacer con este proyecto es simular un espacio de trabajo.\nDonde si bien no aplicamos al 100% metodologia Agile, ni marco Scrum, intentamos hacer lo posible considerando que es un grupo de trabajo interdiciplinario con diferentes husos horarios.\n\nPara ello mediante Trello creamos y asignamos tareas, donde van cambiando de columna según su estado. Una vez realizada, el/la colaborador/a realiza un PR, se hace un Code Review y una vez que al menos 2 aprobadores den el ok, recién ahí se mergea a Main.\nDe esta manera aprenderas cosas del día a día de un ambiente laboral!:\n\n- Metodología Agile\n- Marco Scrum\n- PR\n- Code Review\n- Utilización de diferentes tecnologías que decidimos utilizar en el proyecto, como: Git, Github, Node.js, Express, Mongo, Prisma, entre otras!\n\n# Permisos para contribuir\n\nDebes estar en Discord y en el canal #vamosacodearplanetas pedir que agreguemos tu usuario de GitHub al repositorio que quieras aportar, en este caso back.\n\n# Dependencias, extensiones\n\n- [Node.js](https://nodejs.org/en/) instalar versión LTS\n- [Nvm](https://github.com/nvm-sh/nvm#installing-and-updating)\n- [Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits)\n- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)\n\n# Pre-Instalación\n\nUtilizar el comando `nvm use`, esto verifica si hay un archivo .nvmrc en el proyecto y si no estas usando esa versión la setea. Si no la tenes instalada al final del comentario del package, te deja el comando para instalar la versión correspondiente en tu pc.\n\n# Comenzando, clonación de repositorio\n\n```\ngit clone https://github.com/nsdonato/planetas_api.git\n```\n\n## Instalar dependencias:\n\n```bash\n  npm install my-project\n  cd my-project\n```\n\n## Variables de entorno\n\nRenombrar `.env.template` a `.env` y completar las variables de entorno para que se pueda conectar a url de la base de datos\n\n## Levantar el servidor\n\n```bash\n  npm run dev\n```\n\n## API Reference\n\nLocal: localhost:8000/api/planet\n#### Get item\n\n```http\n  GET /api/planet/${id}\n```\n\n| Parameter | Type     | Description                                     |\n| :-------- | :------- | :---------------------------------------------- |\n| `id`      | `string` | **Required**. fecth a single planet by its name |\n\n#### Health check\n\n```http\n  GET /api/planet\n```\n\n\n## Diagrama de la base de datos\n\nDos tablas con relación uno a uno.\n\n![diagrama db](docs/diagrama%20db.png)\n\n# Ayuda\n\n\nSi tienes cualquier duda puedes preguntar en nuestro [Discord](https://discord.io/vamoacodear) canal #vamosacodearplanetas\n\n\u003c!-- # Pull Request\n`Por favor utilizar el template de Pull Request para poder darle al code reviewer un mejor panorama de lo que va a revisar, gracias.` --\u003e\n# Colaboradores\n\n\n\u003ca href=\"https://github.com/nsdonato/planetas_api/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=nsdonato/planetas_api\" /\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnsdonato%2Fplanetas_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnsdonato%2Fplanetas_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnsdonato%2Fplanetas_api/lists"}