mirror_match/README.md

46 lines
989 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# MirrorMatch
Invite-only photo guessing game: create a **Set** (210 photos) with **24 names**, upload photos (secretly tagged with the correct name + difficulty points), then let your **Group** guess. Reveal results when everyone has guessed or when an admin/uploader decides.
## Repo status
- **Branching**: `main` is protected on Gitea; work is pushed to `dev` and should be merged via PR.
## Tech
- **Web**: Next.js (App Router) + TypeScript + Tailwind
- **DB**: Postgres (Docker Compose)
- **Storage**: MinIO (S3-compatible, Docker Compose)
- **Auth**: Auth.js (NextAuth) + Prisma adapter
## Local development
### 1) Start dependencies
```bash
cd /home/beast/Code/mirrormatch
cp .env.example .env
docker compose up -d
```
### 2) Set up the database
```bash
npx prisma migrate dev
```
### 3) Run the app
```bash
npm run dev
```
Open `http://localhost:3000`.
## Docs
- `docs/ARCHITECTURE.md`
- `docs/DATA_MODEL.md`
- `docs/USER_FLOWS.md`
- `docs/DEPLOY_PROXMOX.md`