README.md

Study-Room

AI study workspace monorepo (frontend + API) using pnpm workspaces.

Quick start

pnpm install

Create .env in repo root if you do not have one yet:

API_PORT=5000
API_ORIGIN=http://localhost:5000
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/study-room
BETTER_AUTH_SECRET=replace-with-32-char-secret-minimum
FRONTEND_ORIGIN=http://localhost:21654
VITE_DEV_PORT=21654
VITE_API_BASE_URL=http://localhost:5000
VITE_BASE_PATH=/
GOOGLE_CLIENT_ID=replace-with-google-client-id
GOOGLE_CLIENT_SECRET=replace-with-google-client-secret
DISCORD_CLIENT_ID=replace-with-discord-client-id
DISCORD_CLIENT_SECRET=replace-with-discord-client-secret

Run

Frontend (main app):

pnpm --filter @workspace/study-workspace dev # run the frontend

API server:

pnpm --filter @workspace/api-server dev # run the backend

Generate/apply DB migration:

pnpm --filter @workspace/db generate # generate the migration if reseted database
pnpm --filter @workspace/db migrate # apply the migration to the database

Useful commands

pnpm run typecheck # check for type errors in the project
pnpm run build # build the project

pnpm --filter @workspace/study-workspace typecheck # check for type errors in the frontend

pnpm --filter @workspace/api-server typecheck # check for type errors in the backend

Early Look of the app

ERD Diagram