diff options
| author | Pinapelz <yukais@pinapelz.com> | 2025-10-08 17:15:58 -0700 |
|---|---|---|
| committer | Pinapelz <yukais@pinapelz.com> | 2025-10-08 17:15:58 -0700 |
| commit | fb2a0c3ca0baf82056ccd147bee5fcae0ed6c0ee (patch) | |
| tree | 74c26149807d70a482283052dcca777c6e4f42ad | |
| parent | 587ee2b3c7c873162d36a666bf5392b780af6df5 (diff) | |
update README add screenshots
| -rw-r--r-- | README.md | 37 | ||||
| -rw-r--r-- | docs/readme-assets/mirage-1.png | bin | 0 -> 227401 bytes | |||
| -rw-r--r-- | docs/readme-assets/mirage-2.png | bin | 0 -> 589173 bytes |
3 files changed, 31 insertions, 6 deletions
@@ -1,16 +1,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. -- React Typescript -- Express -- TailwindCSS -- PostgreSQL -- Prisma ORM -## ✨ Features + + + +# ✨ 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 diff --git a/docs/readme-assets/mirage-1.png b/docs/readme-assets/mirage-1.png Binary files differnew file mode 100644 index 0000000..d0f0157 --- /dev/null +++ b/docs/readme-assets/mirage-1.png diff --git a/docs/readme-assets/mirage-2.png b/docs/readme-assets/mirage-2.png Binary files differnew file mode 100644 index 0000000..4f24f1c --- /dev/null +++ b/docs/readme-assets/mirage-2.png |
