{"id":15101903,"url":"https://github.com/darthkenar/starwarsapi","last_synced_at":"2026-02-12T02:06:31.362Z","repository":{"id":224614318,"uuid":"761928736","full_name":"DarthKenar/StarWarsAPI","owner":"DarthKenar","description":"API StarWars","archived":false,"fork":false,"pushed_at":"2024-09-11T23:26:25.000Z","size":256,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-30T15:26:50.267Z","etag":null,"topics":["bcrypt-nodejs","expressjs","handlebars","javascript","jest","jwt","jwt-authentication","nodejs","typeorm","typescript"],"latest_commit_sha":null,"homepage":"https://f-vega.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/DarthKenar.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-02-22T18:49:24.000Z","updated_at":"2024-09-11T23:26:28.000Z","dependencies_parsed_at":"2024-09-20T06:00:50.900Z","dependency_job_id":null,"html_url":"https://github.com/DarthKenar/StarWarsAPI","commit_stats":null,"previous_names":["darthkenar/starwarsapi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarthKenar%2FStarWarsAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarthKenar%2FStarWarsAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarthKenar%2FStarWarsAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarthKenar%2FStarWarsAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DarthKenar","download_url":"https://codeload.github.com/DarthKenar/StarWarsAPI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237743729,"owners_count":19359287,"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":["bcrypt-nodejs","expressjs","handlebars","javascript","jest","jwt","jwt-authentication","nodejs","typeorm","typescript"],"created_at":"2024-09-25T18:42:53.539Z","updated_at":"2026-02-12T02:06:31.335Z","avatar_url":"https://github.com/DarthKenar.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# STAR WARS API para Kairox\n\n## Para ejecutar servidor local:\n\nClonar repo:\n\n```Bash\ngit clone https://github.com/DarthKenar/StarWarsAPI\n```\n\nVamos al directorio del proyecto:\n\n```Bash\ncd StarWarsAPI\n```\n\nInstalamos dependencias:\n\n```Bash\nnpm install\n```\n\nCompilamos Javascript:\n\n```Bash\nnpx tsc\n```\n\n### Ejecutamos los tests\n\n```Bash\nnpm run test\n```\n\n---\n\n### Ejecutamos el servidor:\n\n```Bash\nnpm run dev\n```\n\nDocumentacion local:\n\nhttp://localhost:3000/api-docs\n\n---\n\n## Modelos - Base de Datos\n\n[Diagrama](./src/docs/models.mmd)\n\n---\n## API Routes\n\n| Host | Method | RoutePath | Action |\n|--|--|--|--|\n| localhost:3000 | GET  |`\"/\"`| Muestra el Home. |\n| localhost:3000 | GET  |`\"/film/s/all\"`| Muestra todas las películas.  |\n| localhost:3000 | GET  |`\"/film/:id\"`| Muestra una película. |\n| localhost:3000 | GET  |`\"/film/s/search\"`| Muestra una lista de películas por nombre. |\n| localhost:3000 | DELETE  |`\"/film/del/:id\"`| Borra los personajes asociados a una película. |\n| localhost:3000 | DELETE  |`\"/film/s/del/all\"`| Borra todas las películas y todos los personajes asociados. |\n|--|--|--|--|\n| localhost:3000 | GET  |`\"/api-docs\"` | Muestra la documentación |\n\n# Project Structure\n\n```\nProjectRoot\n├── dist              \t\t\t\t    // Carpeta distribuible.\n│   ├── views       \t\t\t\t    // Carpeta de Templates.\n│   │   └── layouts  \t\t\t\t    // Diseños de templates base.\n│   │   │   └── mainTemplate.handlebars   \t\t\t\t// Template principal.\n│   │   └── partials  \t\t\t\t                    // Porciones de template como componentes para reutilizar.\n│   │   │   └── checkCharacters.handlebars  \t\t\t// Template que muestra si la película tiene o no personajes en la DB.\n│   │   │   └── searchFilm.handlebars  \t\t\t\t    // Buscador por nombre de película.\n│   │   ├── homeTemplate.handlebars       \t\t\t\t// Template inicial de GET a raiz \"/\"\n│   │   ├── infoTemplate.handlebars       \t\t\t\t// Template que muestra toda la informacion independientemente del path.\n├── src              \t\t\t\t// Carpeta de codigo fuente.\n│   ├── build       \t\t\t\t// Carpeta de compilación.\n│   │   └── controllers  \t \t\t// Carpeta contenedora de los controladores de las rutas.\n│   │   │   └── auth.controller.ts  // Controladores de las rutas para film.\n│   │   │   └── film.controller.ts  // Controladores de las rutas para auth.\n│   │   └── routes  \t \t\t\t// Carpeta de rutas de la API.\n│   │   │   └── auth.routes.ts     \t// Rutas definidas para el modelo Auth.\n│   │   │   └── film.routes.ts     \t// Rutas definidas para el modelo Film.\n│   │   └── utils\t                // Carpeta contenedora de funciones útiles.\n│   │   │   └── auth.utils.ts\t    // funciones útiles para auth.controller.ts.\n│   │   │   └── film.utils.ts\t    // funciones útiles para film.controller.ts.\n│   │   └── validators  \t \t\t// Carpeta contenedora de los controladores de las rutas.\n│   │   │   └── auth.validator.ts\t// validadores para auth.controller.ts.\n│   │   └── app.ts  \t\t\t\t// Archivo de centralización de rutas.\n│   │   └── index.ts  \t\t\t\t// Archivo de ejecución del servidor.\n│   ├── database  \t\t\t\t    // Carpeta referente a la base de datos.\n│   │   └── entity  \t \t\t\t// Carpeta contenedora de los modelos.\n│   │   │   └── models.ts\t        // archivo de definición de los modelos de la base de datos.\n│   │   └── data-source.ts  \t\t// Archivo de configuración de la base de datos.\n│   ├── docs  \t\t\t\t        // Carpeta referente a la documentación.\n│   │   └── models.mmd     \t\t    // Diagrama de modelos realizado en mermaidchart\n│   │   └── swagger.json     \t\t// archivo de configuración para documentación en Swagger\n│   ├── tests  \t\t\t\t        // Carpeta referente a los tests.\n│   │   └── auth.test.ts     \t\t// Testing de funciones utilizadas por los módulos auth.ts\n│   │   └── base.test.ts     \t\t// Testing de funciones independientes y sín módulo. (ej. petición a la raíz \"/\")\n│   │   └── film.test.ts     \t\t// Testing de funciones utilizadas por los módulos film.ts\n├── .gitignore       \t\t\t\t// Archivo gitignore estándar.\n├── package-lock.json     \t\t    // Dependencias de librerías exactas de Node.js\n├── package.json     \t\t\t\t// Dependencias de librerías de Node.js\n├── README.md                       // Archivo Readme.md estándar.\n└── tsconfig.json    \t\t\t\t// Configuración para compilación de Typescript\n```\n\n# Project Dependencies \n\n**Prodution Dependencies** \n\n1. \"axios\": \"^1.6.7\",\n\n2. \"bcrypt\": \"^5.1.1\",\n\n3. \"cross-env\": \"^7.0.3\",\n\n4. \"dotenv\": \"^16.4.5\",\n\n5. \"express\": \"^4.18.2\",\n\n6. \"reflect-metadata\": \"^0.2.1\",\n\n7. \"sqlite3\": \"^5.1.7\",\n\n8. \"swagger-ui-express\": \"^5.0.0\",\n\n9.  \"typeorm\": \"^0.3.20\"\n\n**Dev Dependencies** \n\n1. \"@types/express\": \"^4.17.21\",\n\n2. \"@types/jest\": \"^29.5.12\",\n\n3. \"@types/node\": \"^20.11.24\",\n\n4. \"@types/supertest\": \"^6.0.2\",\n\n5. \"jest\": \"^29.7.0\",\n\n6. \"nodemon\": \"^3.1.0\",\n\n7. \"ts-jest\": \"^29.1.2\",\n\n8. \"supertest\": \"^6.3.4\",\n\n9.  \"typescript\": \"^5.3.3\"\n\n## Objetivos\n\nUtilizando la [API STAR WARS](https://swapi.dev/documentation), podrás obtener las películas y personajes de cada entrega.\n(Requerido)\n\n---\n\n### Desafío 1\n\nEs necesario tener todas las películas, para ello debemos guardar en una base local todas las películas con los campos que creas necesarios. Inicialmente se consulta a la BD local preguntando si existen esas películas, si no existen vamos a la API y guardamos las películas localmente para optimizar los tiempos de respuesta y no ir cada vez a la API externa.\n\n### Desafío 2\n\nAl consultar cada película esta tiene que guardar en una base local todos los personajes relacionados a esta con los campos nombre, género, películas y especie. Inicialmente se consulta a la BD local preguntando si existen esos personajes, si no existen vamos a la API y guardamos los personajes localmente para optimizar los tiempos de respuesta y no ir cada vez a la API externa.\n\n### Desafío 3\n\nCrear un endpoint que borre los personajes de la película indicada de la base de datos. Crear un endpoint que borre TODOS los datos de la Base de datos.\n\n---\n\n#### Desafío Opcional (Bonus extra)\n\n- Hacer un buscador de películas, especies.\n\n- Implementar login user y pass. Middleware de verificación token. (authentication)\n\n##### Aclaraciones\n\n- Usar Node js (Typescript)\n- Utilizar Swagger para la documentación de la API (no excluyente)\n- La BD puede ser cualquiera\n- Se debe exponer el endpoint de consulta de películas para ser utilizada\n- Proponer diseño y lógica en cada desafío.\n- Se puede subir a github/gitlab y compartir el link o bien un zip.\n- Proponer manejo de errores (404, 401, 400, 500)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarthkenar%2Fstarwarsapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarthkenar%2Fstarwarsapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarthkenar%2Fstarwarsapi/lists"}