README.md

DXRating

Usage

Apps and Packages

Apps

• apps/web: the main web app that provides both the web and iOS app variant of the DXRating website

Packages

• packages/dxdata: a package that provides annotated, ready to use maimai DX songs & sheets metadata, generated by scripts/annotator
• packages/self-hosted-functions: a package that provides self hosted functions wrapped with Koa.js

Scripts

• scripts/annotator: a script that annotates maimai DX songs & sheets metadata from various sources

Source-related Tools

• packages/eslint-config-custom: a package that provides custom ESLint configuration
• packages/tsconfig: a package that provides custom TypeScript configuration

Utilities

This Turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

To build all apps and packages, run the following command:

cd dxrating
yarn build

Develop

To develop all apps and packages, run the following command:

cd dxrating
yarn dev

Useful Links

Learn more about Turborepo, the monorepo tool used in this project: Documentation / CLI Usage

License

MIT

Security

If you find a vulnerability in the repository, please email the organization owner (vulnerability@dxrating.net). We kindly ask you not to disclose the detail of the vulnerability to the public before we have released a fix. Thanks for making DXRating a better site!

Contributors

This project is made possible by the following contributors. Contributions are always welcome!