Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/cornell-dti/course-plan/llms.txt

Use this file to discover all available pages before exploring further.

Getting Courseplan running locally takes about five minutes. By the end of these steps you will have a Vite dev server running at localhost:8080 with hot-module replacement, connected to Firebase/Firestore for authentication and data persistence.

​
Prerequisites

  • Node.js 14 or later (the project targets Node 14 via @tsconfig/node14)
  • npm (bundled with Node.js)
  • A Cornell Google account — Courseplan uses Firebase Authentication with Google sign-in, so you need a @cornell.edu address (or a Firebase project configured for your own domain) to log in during local development

​
Setting up the project

1

Clone the repository

git clone https://github.com/cornell-dti/course-plan.git
cd course-plan
2

Install dependencies

npm install
This installs both production and development dependencies, including Vue 3, Vuex 4, Vite, Jest, Cypress, ESLint, and Prettier.
3

Start the development server

npm run serve
Vite compiles the app and starts a dev server with hot-module replacement. The first build may take 10–20 seconds.
4

Open the app

Navigate to http://localhost:8080 in your browser and sign in with your Cornell Google account.

​
Available npm scripts

# Start Vite in development mode (HMR enabled)
npm run serve

# Start Vite against the production Firebase project
npm run serve:prod
Run npm run lint and npm test before opening a pull request. The CI pipeline enforces both.

Build docs developers (and LLMs) love

Get started for freeTalk to us