Skip to content
repo-edu

Quick Start

After installing, run through these steps to verify everything works.

1. Build the project

Section titled “1. Build the project”
Terminal window
pnpm build

This compiles all workspace packages and apps.

2. Launch the desktop app

Section titled “2. Launch the desktop app”
Terminal window
pnpm dev

A desktop window should open showing the repo-edu interface. If it doesn’t, check the terminal output for errors — see Troubleshooting for common issues.

3. Try the CLI

Section titled “3. Try the CLI”
Terminal window
pnpm build:cli
./apps/cli/dist/redu course list
./apps/cli/dist/redu repo update --help

The first command builds the CLI. The second lists available courses (empty if this is a fresh installation). The third shows the help for the repo update command.

4. Build and test the docs site

Section titled “4. Build and test the docs site”
Terminal window
pnpm docs:build
pnpm docs:test

The docs site includes an embedded demo that runs the real application against mock data in the browser. The build and test commands verify that the demo works correctly.

5. Run full validation

Section titled “5. Run full validation”
Terminal window
pnpm check

This runs linting, type checking, and all tests across the workspace. Use this before committing changes to catch issues early.