{"id":16402348,"url":"https://github.com/santospatrick/genshin-api","last_synced_at":"2025-03-23T05:31:13.683Z","repository":{"id":117478236,"uuid":"308034928","full_name":"santospatrick/genshin-api","owner":"santospatrick","description":":video_game: Genshin Impact public REST API serving data from a Web Scraping approach","archived":false,"fork":false,"pushed_at":"2023-04-03T01:15:14.000Z","size":5753,"stargazers_count":16,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-18T18:06:15.445Z","etag":null,"topics":["adonisjs","genshin-api","genshin-impact","postman","swagger"],"latest_commit_sha":null,"homepage":"https://genshin-api.santospatrick.com/docs/","language":"JavaScript","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/santospatrick.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":"2020-10-28T14:02:39.000Z","updated_at":"2025-01-10T04:14:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"b2352bbe-9613-4d7f-a731-e1d2b973785c","html_url":"https://github.com/santospatrick/genshin-api","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/santospatrick%2Fgenshin-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/santospatrick%2Fgenshin-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/santospatrick%2Fgenshin-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/santospatrick%2Fgenshin-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/santospatrick","download_url":"https://codeload.github.com/santospatrick/genshin-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245061382,"owners_count":20554563,"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":["adonisjs","genshin-api","genshin-impact","postman","swagger"],"created_at":"2024-10-11T05:45:57.196Z","updated_at":"2025-03-23T05:31:13.647Z","avatar_url":"https://github.com/santospatrick.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# genshin-api\nGenshin public REST API serving data from a Web Scraping approach\n\n[![Aerith \u0026 tricks at Genshin Impact world giving welcome for contributors!](docs/readme.png)](https://genshin-api.santospatrick.com/docs)\n\n## API Docs\n\n| Environment | Swagger Online Docs |\n|-------------|---------------------|\n| Production  | [![Swagger Production Badge](https://validator.swagger.io/validator?url=https://genshin-api.santospatrick.com/swagger.json)](https://genshin-api.santospatrick.com/docs/) |\n\n## Roadmap\n\n| Feature              | Endpoint                   | Status          |\n|----------------------|----------------------------|-----------------|\n| Puppeteer Setup      | -                          | :white_check_mark: |\n| Database Setup       | -                          | :white_check_mark: |\n| Docker Setup         | -                          | :white_check_mark: |\n| Public Swagger       | GET /docs                  | :white_check_mark: |\n| Signup               | POST /api/v1/auth/register | :white_check_mark: |\n| Login                | POST /api/v1/auth/login    | :white_check_mark: |\n| Characters List      | GET /api/v1/characters     | :white_check_mark: |\n| Character Details    | GET /api/v1/characters/:id | :white_check_mark: |\n| Deploy v0.1.0        | https://genshin-api.santospatrick.com/docs | :white_check_mark: |\n\n## Development\n\n1. Setup a PostgreSQL database (example with docker):\n```\ndocker run --name database -e POSTGRES_PASSWORD=root -p 5432:5432 -d postgres\n```\n\n2. Duplicate `.env.example` to `.env` fulfilling variables as needed\n\n3. Run the following commands:\n```\nyarn install\nyarn adonis key:generate\nyarn adonis migration:run\nyarn dev\n```\n\n4. Done 🎉 (access http://localhost:3333)\n\n## Production\n\n1. Clone this repo:\n```\ngit clone git@github.com:santospatrick/genshin-api.git\n```\n\n2. Duplicate `.env.example` to `.env` fulfilling variables as needed\n```bash\ncp .env.example .env\nvim .env\n# edit variables\n```\n\n3. Run docker-compose and migrations:\n```\ndocker-compose up -d\ndocker exec -it YourAppName sh\nyarn adonis key:generate\nyarn adonis migration:run\n```\n\n4. Done 🎉 \n\n## Postman\n\n[Download project's postman collection](https://raw.githubusercontent.com/santospatrick/genshin-api/main/postman/Genshin.postman_collection.json) to test endpoints\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsantospatrick%2Fgenshin-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsantospatrick%2Fgenshin-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsantospatrick%2Fgenshin-api/lists"}