{"id":16623145,"url":"https://github.com/gazmull/kamihime-database","last_synced_at":"2025-10-28T21:08:47.807Z","repository":{"id":39861908,"uuid":"123783166","full_name":"gazmull/kamihime-database","owner":"gazmull","description":"[R18] Website + API for Kamihime Database","archived":false,"fork":false,"pushed_at":"2023-06-02T09:20:39.000Z","size":3726,"stargazers_count":3,"open_issues_count":20,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-23T01:05:07.292Z","etag":null,"topics":["api-rest","kamihime","kamihime-database","nodejs","r18","server","website"],"latest_commit_sha":null,"homepage":"https://kamihimedb.win","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gazmull.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2018-03-04T11:44:06.000Z","updated_at":"2024-02-09T09:03:53.000Z","dependencies_parsed_at":"2025-02-14T20:42:24.568Z","dependency_job_id":null,"html_url":"https://github.com/gazmull/kamihime-database","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/gazmull/kamihime-database","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazmull%2Fkamihime-database","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazmull%2Fkamihime-database/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazmull%2Fkamihime-database/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazmull%2Fkamihime-database/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gazmull","download_url":"https://codeload.github.com/gazmull/kamihime-database/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazmull%2Fkamihime-database/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261392027,"owners_count":23151712,"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-rest","kamihime","kamihime-database","nodejs","r18","server","website"],"created_at":"2024-10-12T03:22:39.555Z","updated_at":"2025-10-28T21:08:42.774Z","avatar_url":"https://github.com/gazmull.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/gazmull/kamihime-database.svg?branch=master)](https://travis-ci.org/gazmull/kamihime-database)\n# Kamihime Database\nWebsite + REST (JSON) API for Kamihime Database\n\u003cbr\u003e Character statistics are provided by [Kamihime Project Wikia (Nutaku)](https://kamihime-project.wikia.com)\n\n## Links\n- [Site](https://kamihimedb.thegzm.space)\n- [Support](http://support.thegzm.space)\n- [API Documentation](https://gazmull.github.io/kamihime-database)\n- [Changelog](/CHANGELOG.md)\n- [Util/Scenario `.blacklist`](https://gist.github.com/gazmull/45cd187e4a476795bcef630a8018e1a6)\n\n## Recommendations\n- VS Code Extensions\n    1. **[Live Sass Compiler](https://marketplace.visualstudio.com/items?itemName=ritwickdey.live-sass)** For watching saved Sass files and applying vendor prefixes on compilation.\n\n## Requirements\n- [nginx (skip to nginx section)](http://blog.danyll.com/setting-up-express-with-nginx-and-pm2/)\n- [Node](https://nodejs.org) 10 or 11\n- [MariaDB](https://mariadb.org) 10\n- [Discord App + Bot Account](https://discordapp.com/developers/applications/me)\n- [Github Personal Access Token](https://github.com/settings/tokens)\n- [Build Tools (**Windows**)](https://github.com/felixrieseberg/windows-build-tools) | [Build Tools (**Linux**)](https://superuser.com/questions/352000/whats-a-good-way-to-install-build-essentials-all-common-useful-commands-on)\n\n## Notice\n- I do not guarantee 100% coverage of the project within this documentation. If there is really something needed to be added, see [Contributing](#Contributing).\n- **App Config**: Please configure `auth.ts`. Get its template from `auth.example.ts`\n    - It can be found at `src/auth` folder.\n- **MariaDB**: Import database schema to your created database (default: `kamihimedb`) with `utf8_unicode_ci` collation.\n    - The `db.zip` file will not be updated for every new character release. It only serves as a starting kit for running the website.\n- **Util/Scenario**: If you found non-existent files that causes error on any story/scenario, please report [here](https://gist.github.com/gazmull/45cd187e4a476795bcef630a8018e1a6).\n    - Once the reported files are added, you may do `$ yarn run scenarios-v` again. See [Procedures-3](#Procedures) for more info.\n- **Package Manager**: [Yarn](https://yarnpkg.com/en/docs/getting-started) is recommended.\n\n## Procedures\n1. Read [Requirements](#Requirements) and [Notice](#Notice).\n2. Run `$ yarn`\n    - You have to build the src too: `$ yarn --production=false`\n3. Run `$ yarn run scenarios` to generate episode resources.\n    - Or `$ yarn run scenarios-v` to run with verbose logging.\n    - Append `-l#` or `--latest=#` to generate episode resources based on the number provided (e.g: 5 is for 5 characters). `#` is for a number.\n        - This is not compatible with `--id`.\n        - e.g: `-l5` or `--latest=5`\n    - Append `-i{{id}}` or `--id={{id}}` to generate episode resources based on the character provided. `{{id}}` is for a character ID.\n        - This is not compatible with `--latest`.\n        - e.g.: `-ik0001` or `--id=k0001`\n    - Append `--eidolon` / `--soul` / `--ssr+` / `--ssr` / `--sr` / `--r` (rarity options are for `kamihime`) to generate episode resources strictly in the character type specified.\n        - This is compatible with `--latest` but **not** with `--id`.\n4. Run `$ yarn run build`\n5. Run `$ node .`\n    - `$ yarn run pm2` for PM2 preference / production stage.\n\n## Contributing\n- Looking for feedbacks, so feel free to file an issue or a pull request!\n- For code-related:\n    - Fork this repository, clone to your machine, and follow the project's development configuration [e.g. TSLint]\n        - `$ yarn --production=false` to install.\n    - For `src/views`-related, you may use the task `Move PUG Files` to easily copy the new changes from `src` to `build`.\n        - This only works with VSCode. However for CLI you may run this: `$ yarn run finalize --pug`\n    - For Sass compilation, see [VS Code Extensions-1](#Recommendations)\n    - Run `$ yarn run build` to verify if your build is passing.\n        - Failing build will be rejected at default.\n\n## License\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazmull%2Fkamihime-database","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgazmull%2Fkamihime-database","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazmull%2Fkamihime-database/lists"}