Skip to content

README.md

Latest commit

 

History

History
147 lines (103 loc) · 4.77 KB

README.md

File metadata and controls

147 lines (103 loc) · 4.77 KB

TritonScript

A collaborative class notes platform built for UCSD students, by CSES @ UC San Diego.

License Discord Contributors Issues

Table of Contents

About

TritonScript is an open-source web application where UC San Diego students can upload, browse, and share class notes across courses. It is developed and maintained by the Computer Science and Engineering Society (CSES) at UCSD.

The project is open to all contributors — whether you are a UCSD student, a CSES member, or a developer from the broader open-source community.

Features

  • Browse and search class notes organized by course
  • Upload notes with cloud file storage
  • User authentication with Google OAuth and JWT sessions
  • User profiles and personal note management

Tech Stack

Layer Technologies
Frontend React 18, TypeScript, Vite
Backend Node.js, Express, TypeScript
Database & Storage Supabase (PostgreSQL) via Prisma ORM, Cloudflare R2 (file uploads)

Getting Started

Prerequisites

Quick Start

  1. Clone the repository

    git clone https://github.com/CSES-Open-Source/TritonScript-legacy.git
cd TritonScript-legacy

  2. Run the frontend

    cd frontend
pnpm install
pnpm run dev

  3. Run the backend

    cd backend
pnpm install
pnpm run dev

For full setup instructions including environment variables and database configuration, see CONTRIBUTING.md.

Project Structure

TritonScript/
├── frontend/               # React + TypeScript + Vite
│   └── src/
│       ├── components/     # Reusable UI components
│       ├── pages/          # Route-level page components
│       └── utils/          # Shared utilities
│
├── backend/                # Node.js + Express + TypeScript
│   ├── controllers/        # Route handler logic
│   ├── routes/             # Express route definitions
│   ├── models/             # Data models
│   ├── prisma/             # Prisma schema and migrations
│   ├── scraper/            # Course data scraper
│   └── utils/              # Shared utilities
│
├── CONTRIBUTING.md
├── CODE_OF_CONDUCT.md
└── README.md

Contributing

Contributions are welcome from everyone. Browse open issues to find something to work on, then read CONTRIBUTING.md for the full setup guide, branch conventions, and workflow.

Community & Contact

Discord — The primary place for discussion, questions, and announcements: Join the CSES Discord

Maintainers

Name Role
Hogun Kim Engineering Manager
Victoria Tran Engineering Manager
Aayan Lakhani Software Developer
Kyle Koh Software Developer

Contact

CSES @ UC San Diego

License

This project is licensed under the MIT License.