TigerPath

KO | EN

gitlite — search

#javascript #react #ai #typescript #android #machine-learning #deep-learning #java #nodejs #windows #vue #awesome-list #security #openai

(★ 18)

Four-year course planner for Princeton University students

TigerPath Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TigerPath

TigerPath is a web app that helps Princeton University students plan out their four-year course schedules. It began as a COS 333 project by Richard Chu, Barak Nehoran, Adeniji Ogunlana, and Daniel Leung.

You can visit TigerPath at [path.tigerapps.org](https://path.tigerapps.org).

To learn about contributing to TigerPath, take a look at the [contributing guidelines](https://github.com/PrincetonUSG/TigerPath/blob/master/CONTRIBUTING.md).

For EC2 + Nginx production setup (with Redis in Docker and external RDS), see [DEPLOYMENT.md](DEPLOYMENT.md).

# Prerequisites

- [uv](https://docs.astral.sh/uv/getting-started/installation/) (Python package manager)
- [Bun](https://bun.sh/docs/installation) (JavaScript runtime)
- [Docker](https://docs.docker.com/get-docker/) (for local PostgreSQL + Redis, or use local installs)

# Quick start

```bash
git clone https://github.com/TigerAppsOrg/TigerPath && cd TigerPath
uv python install 3.11
uv venv --python 3.11
source .venv/bin/activate
cp .env.example .env              # defaults work out of the box
make deps-up                       # start Postgres + Redis
make setup                         # install deps + run migrations
make seed-majors                   # load baseline major data
# Optional: if CONSUMER_KEY and CONSUMER_SECRET are set in .env
# make seed-courses                # import course catalog from Princeton MobileApp API
make dev                           # start Django (:8000) + Vite asset server (:3000)
```

Open http://localhost:8000/ in your browser. (Port 3000 is the Vite asset server — you don't open it directly.)

If you have Princeton MobileApp API credentials, you can also run `make seed-data` (majors + courses) instead of running `make seed-majors` and `make seed-courses` separately.

# Setup details

### Python environment

1. Install Python 3.11: `uv python install 3.11`
2. Create and activate a virtual environment:
   ```bash
   uv venv --python 3.11
   source .venv/bin/activate
   ```
3. Install dependencies: `uv pip install -r requirements.txt`

### Frontend packages

```bash
cd frontend && bun install
```

### Environment variables

Copy the example env file — the defaults connect to the Docker Compose Postgres and enable Vite dev mode:

```bash
cp .env.example .env
```

The `.env` file is auto-loaded by `manage.py`, so you don't need to source it manually.

To enable Redis-backed search caching locally, set:

```bash
REDIS_URL=redis://localhost:6379/1
```

Cache growth safeguards:
- Redis (Docker) defaults to `REDIS_MAXMEMORY=256mb` with `allkeys-lru` eviction.
- Non-Redis local cache is capped by `CACHE_MAX_ENTRIES` (default `2000`).

### Database

Start Postgres and Redis via Docker Compose:

```bash
make deps-up
```

Then run migrations:

```bash
make migrate
```

To populate majors and courses in one step:

```bash
make seed-data
```

Note: `make seed-courses` / `make seed-data` require Princeton MobileApp API credentials in `.env`:
`CONSUMER_KEY` and `CONSUMER_SECRET`.
If Princeton changes API paths, you can also set `MOBILEAPP_BASE_URL`.

Or run them separately:

```bash
make seed-majors
make seed-courses
```

# Development

### Running the dev servers

```bash
make dev    # runs Django (:8000) and Vite (:3000) in parallel
```

Or run them separately:

```bash
make dev-backend     # Django on :8000
make dev-frontend    # Vite on :3000
```

### Testing, linting, formatting

```bash
make test      # run Python and JS tests
make lint      # ruff (Python) + eslint (JS)
make format    # auto-format Python and JS
```

### Database commands

```bash
make migrate           # run migrations
make makemigrations    # create new migrations
make dbshell           # open psql shell
make reset-db          # flush all data and re-migrate
make deps-up           # start local Postgres + Redis in Docker
make seed-data         # load majors + scrape/import courses
```

### Scraping courses

```bash
make seed-courses
```

This command requires:
- `CONSUMER_KEY`
- `CONSUMER_SECRET`
- (optional) `MOBILEAPP_BASE_URL` override when OIT changes endpoint versions

### All Makefile targets

Run `make help` to see every available command.

TigerPath

TigerPath Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

TigerPath

TigerPath Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README