Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions clubscan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ clubscan/
| 5 | [Infrastructure Architecture](docs/05-infrastructure-architecture.md) |
| 6 | [Security Architecture](docs/06-security-architecture.md) |
| 7 | [Folder Structures](docs/07-folder-structures.md) |
| 8 | [Implementation Status](docs/08-implementation-status.md) |

## Quick start (local)

Expand All @@ -39,12 +40,12 @@ docker compose up -d postgres redis minio createbuckets mailhog
# 2) Backend
cd backend
cp .env.example .env
pnpm install
pnpm prisma:generate
pnpm prisma migrate dev # baseline schema
npm install
npm run prisma:generate
npm run prisma migrate dev # baseline schema
psql "$DATABASE_URL" -f prisma/sql/postgis.sql # geospatial augmentation
pnpm prisma:seed
pnpm start:dev # http://localhost:3000/api/v1 (docs at /api/v1/docs)
npm run prisma:seed
npm run start:dev # http://localhost:3000/api/v1 (docs at /api/v1/docs)
```

## The ClubScan Score
Expand All @@ -59,8 +60,8 @@ aggregate that prioritizes safety and resists manipulation. See

**Mobile:** Expo · TypeScript · Expo Router · TanStack Query · Zustand · RHF + Zod · NativeWind
**Backend:** NestJS · TypeScript · Prisma · PostgreSQL · Redis
**Auth:** JWT (access) + rotating refresh tokens + Google/Apple OAuth
**Infra:** Docker · GitHub Actions · S3-compatible storage · FCM · Sentry · OpenTelemetry
**Auth:** JWT (access) + rotating refresh tokens + Google/Apple OAuth (JWKS-verified)
**Infra:** Docker · GitHub Actions · S3-compatible storage · FCM (firebase-admin) · Sentry · OpenTelemetry

## License

Expand Down
6 changes: 6 additions & 0 deletions clubscan/backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
"seed": "tsx prisma/seed.ts"
},
"dependencies": {
"@aws-sdk/client-s3": "^3.658.0",
"@aws-sdk/s3-request-presigner": "^3.658.0",
"@nestjs/common": "^10.4.4",
"@nestjs/config": "^3.2.3",
"@nestjs/core": "^10.4.4",
Expand All @@ -35,9 +37,12 @@
"@prisma/client": "^5.20.0",
"argon2": "^0.41.1",
"axios": "^1.7.7",
"firebase-admin": "^13.10.0",
"google-auth-library": "^9.14.1",
"helmet": "^8.0.0",
"ioredis": "^5.4.1",
"jsonwebtoken": "^9.0.3",
"jwks-rsa": "^4.0.1",
"nestjs-i18n": "^10.4.9",
"nestjs-zod": "^3.0.0",
"reflect-metadata": "^0.2.2",
Expand All @@ -49,6 +54,7 @@
"@nestjs/cli": "^10.4.5",
"@nestjs/testing": "^10.4.4",
"@types/express": "^4.17.21",
"@types/jsonwebtoken": "^9.0.10",
"@types/node": "^22.7.4",
"@types/uuid": "^10.0.0",
"@typescript-eslint/eslint-plugin": "^8.8.0",
Expand Down
Loading
Loading