Skip to content

shigeru22/osuscorerank-web

Repository files navigation

osu! Inactive User Score Ranking Viewer

This project is intended to recreate Venta's spreadsheet with the same purpose into a website.

Uses osu!api v2 to retrieve the scores to a database periodically due to rate limits.

Setup

Make sure to install Node.js (tested using v14.17.6 with NVM for Windows), Rust toolchain, and wasm-pack globally. To prepare the environment, do these steps:

  1. Clone the repository.

  2. Inside the repository's folder, build Rust Wasm module from the provided NPM script. This compiles the Rust project, runs wasm-pack, and outputs the build inside /pkg in /wasm project directory.

    Note: Run this before installing Node dependencies, since the output build will be used for it!

    $ npm run build-wasm
  3. Inside the repository's folder, install the dependencies used for the project.

    $ npm install
  4. Start development server using this command.

    $ npm start

To create an optimized production build, run npm run build instead of npm start. Build results could be found inside build folder and may be served using any HTTP server.