UWDSC Website v3 - Documentation

Welcome to the UW Data Science Club monorepo documentation! This comprehensive guide will help you understand our codebase architecture, setup process, and development workflow.

๐Ÿš€ What is this project?

This is a modern, full-stack monorepo that powers the UW Data Science Clubโ€™s digital presence, including:

  • Main Website (apps/web) - The primary UWDSC website
  • CXC App (apps/cxc) - Dedicated AI hackathon application
  • Shared UI Package (packages/ui) - Design system with shadcn/ui components
  • Backend Services (packages/server) - Shared backend logic and data layer

๐Ÿš€ Getting Started

Set up your development environment and run the apps

View Guide โ†’

๐Ÿ—๏ธ Architecture

Learn about our monorepo structure and design patterns

View Architecture โ†’

๐Ÿ“š Guides

Step-by-step tutorials for common development tasks

View Guides โ†’

๐Ÿ“ฆ Packages

Detailed documentation for each package in the monorepo

View Packages โ†’

๐Ÿ“ Timeline

Track features and updates organized by semester

View Timeline โ†’

๐Ÿ› ๏ธ Tech Stack

Our monorepo is built with modern technologies:

  • Frontend: Next.js 15, React 19, TypeScript
  • Styling: Tailwind CSS, shadcn/ui
  • Backend: Supabase, pg (node-postgres), db-mate, PostgreSQL
  • Monorepo: Turborepo, pnpm workspaces
  • Validation: Zod
  • Animation: Framer Motion

๐Ÿ“– Documentation Structure

  • Getting Started - Installation, setup, and first steps
  • Architecture - System design, data flow, and patterns
  • Guides - Practical tutorials for common tasks
  • Packages - In-depth package documentation
  • Contributing - Guidelines for contributors

๐Ÿค Contributing

We welcome contributions! Check out our Contributing Guide to get started.

๐Ÿ“ License

This project is licensed under the MIT License.