Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 2.24 KB

File metadata and controls

40 lines (31 loc) · 2.24 KB

Documentation

This folder is the reference for query, the Data Science at Georgia Tech (DSGT) monorepo for club operations and digital infrastructure.

Members looking for a club-language overview should start at Club project. For local setup and review rules, jump to the page that matches the work you are doing.

Document What it covers
Club project What the live site is, who uses it, current status, how to help
Getting started Prerequisites, local Postgres, env vars, first pnpm dev
Architecture How the two sites and four packages fit together
Contributing Branches, scripts, tests, and review expectations
Environment variables Every env var the process actually reads
Deployment Firebase App Hosting, Firebase Hosting, GCP secrets
CI/CD GitHub Actions, Dependabot, branch automation
Security Auth gates, rate limits, CSP, input scrubbing
Testing Vitest, Playwright, and what each suite protects
Resume book Member uploads, the two staff views, limits, and why files skip tRPC
Bootcamp materials Weekly workshop ZIPs: who can download one, publishing, session dates, storage
Glossary Club vs hackathon vocabulary

Packages

Document Workspace Role
API @query/api tRPC routers, middleware, pricing
Auth @query/auth NextAuth, providers, mailer
Database @query/db Drizzle schema, client, membership rules
UI @query/ui Shared React components and styles

Sites

Document Workspace Role
Main website web Public club site plus the authenticated portal
Hacklytics 2027 hacklytics2027 Static event marketing site

Tooling

Shared ESLint, Prettier, Tailwind, and TypeScript configs live under tooling/.