Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/SdazaP/ruTournament/llms.txt

Use this file to discover all available pages before exploring further.

ruTournament is a Vite single-page application that runs entirely in the browser. The Node.js toolchain is only needed to compile and serve the frontend assets — there is no backend process, no database server, and no environment variables to configure. Once the dev server is running, the entire application (including data storage) operates inside your browser.
Prerequisites
  • Node.js v16 or later — download from nodejs.org. Check your version with node -v.
  • npm (bundled with Node.js), yarn, or pnpm as your package manager.
  • Google Chrome or Microsoft Edge are recommended for best IndexedDB compatibility and performance. Firefox works but may have subtle IndexedDB transaction differences.

​
Setup

1

Clone the Repository

Open your terminal and clone the ruTournament source repository from GitHub:
git clone https://github.com/SdazaP/ruTournament.git
Then move into the project directory:
cd ruTournament
2

Install Dependencies

Install all required packages using your preferred package manager:
npm install
This installs all dependencies and devDependencies listed in package.json, including React 18, Vite 4, Tailwind CSS 3, Dexie.js, React Router v6, and the cstimer_module scramble generator.
3

Start the Development Server

Launch the Vite development server with:
npm run dev
Vite will compile the project and print a local URL to the terminal. Open it in your browser:
http://localhost:5173
The app loads with hot-module replacement enabled — any source file changes you make will reflect in the browser instantly without a full reload.
4

Build for Production (Optional)

When you are ready to deploy a production-optimized build, run:
npm run build
Vite compiles and minifies all assets into the dist/ directory. You can preview the production bundle locally before deploying:
npm run preview
This starts a lightweight local server pointing at dist/, letting you verify the production build behaves identically to the dev server.

​
Deploying to Vercel

The repository ships with a vercel.json that configures SPA-style URL rewrites — all routes are redirected to index.html so that React Router can handle client-side navigation correctly:
vercel.json
{
  "rewrites": [
    {
      "source": "/(.*)",
      "destination": "/"
    }
  ]
}
To deploy:
  1. Push your clone (or fork) to a GitHub repository.
  2. Go to vercel.com and click Add New Project.
  3. Import the GitHub repository — Vercel will automatically detect the Vite framework.
  4. Click Deploy. No environment variables or build-command overrides are needed.
Vercel will build from the main branch and every subsequent push will trigger a new deployment automatically.
Your tournament data is stored only in your browser’s IndexedDB. It is never sent to Vercel or any other server.
  • Clearing your browser history, cookies, or site data will permanently delete all tournaments.
  • Using a different browser or a different device will show an empty tournament list — the data does not sync.
  • Private / incognito windows use a separate, ephemeral IndexedDB that is wiped when the window closes.
Before clearing browser data, export any tournaments you wish to keep. There is no automatic cloud backup.

​
Available Scripts

ScriptDescription
npm run devStart Vite dev server on port 5173 with hot-module replacement
npm run buildProduction build — compiles and minifies assets to dist/
npm run previewPreview the production build locally using Vite’s built-in static server

Build docs developers (and LLMs) love

Get started for freeTalk to us