aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 31 insertions, 6 deletions
diff --git a/README.md b/README.md
index e2d213a..6f81be9 100644
--- a/README.md
+++ b/README.md
@@ -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
+![docs/readme-assets/mirage-1.png](docs/readme-assets/mirage-1.png)
+![docs/readme-assets/mirage-2.png](docs/readme-assets/mirage-2.png)
+
+# ✨ 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
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage