MCity Club

Requirements

• Node.js (lts/*, see .nvmrc)
• pnpm (enabled via corepack enable)
• A Firebase project with Auth, Firestore and Storage

Alternatively, Docker with Compose — see Docker.

Setup

pnpm i
cp .env.example .env

Paste your Firebase web app config into VITE_FIREBASE_CONFIG as one line of JSON.

Admin access

The admin area (/dashboard and the /admin_* pages) is open only to users with a document at admins/{uid} in Firestore. To make someone an admin, create a user under Authentication in the Firebase console, copy their UID, and add an empty document with that ID to the admins collection. Signing in alone is not enough.

Security rules

firestore.rules and storage.rules enforce the same admin check on the server. Deploy them with:

npx firebase-tools deploy --only firestore:rules,storage --project <your-project-id>

Local emulators

To work without touching a real project (requires Java), start the emulators and point the app at them:

npx firebase-tools emulators:start --project demo-mcity --only auth,firestore,storage
VITE_FIREBASE_EMULATORS=true pnpm dev

Scripts

Command	Description
pnpm dev	Start the dev server on localhost:5000
pnpm build	Type-check and build to dist/
pnpm preview	Serve the production build locally
pnpm lint	Lint with ESLint
pnpm lint:fix	Lint and auto-fix

Docker

docker compose up --build -d

The source is bind-mounted for hot reload and the app is served on port 5000. The container runs as UID/GID 911, so either sudo chown -R 911:911 . or set UID and GID in .env to your own id -u / id -g.

Deployment

Configured for Netlify via netlify.toml, which rewrites all paths to the SPA entry point. Any static host works — publish dist/ with the same SPA fallback. Remember to set VITE_FIREBASE_CONFIG in the host’s build environment.

CI (.github/workflows/ci.yml) runs lint and build on pushes and pull requests to main.