README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# Mirage

**Mirage** is a rhythm game score tracker that doesn’t rely on predefined seeds or chart metadata. It preseves your scores across games — even niche ones.

![docs/readme-assets/mirage-1.png](docs/readme-assets/mirage-1.png)
![https://github.com/user-attachments/assets/63341f3b-991c-4147-8014-30f27020dc05](https://github.com/user-attachments/assets/63341f3b-991c-4147-8014-30f27020dc05)

# ✨ Features
- **Import & Track Scores** – Keep a safe backup of your game scores.
- **Add Any Game** – Works with any rhythm game, even without official metadata.
- **Self-Host or Go Solo** – Use locally or host for group score tracking. Multi-user system.
- **Presets** - Comes pre-loaded with tracking functionality for various rhythm games

> ⚠️ **Warning:** Work in progress

# Development
Install dependencies:
```bash
pnpm install:all1
```

Create a `.env` file in `backend` based on `backend/.env.template`. Fill in the fields as required.

Setup and Initialize Database:
```bash
pnpm db-init
```

Create a `.env` file in `frontend` based on `frontend/.env.template`
- If you did not change the port of the API in the backend env file. Then your `VITE_API_URL` is `http://localhost:5000/api`

Start Frontend and Backend
```bash
pnpm dev
```

## Stack
- React Typescript
- Express
- Prisma ORM
- Postgres