exam-study-platform

KO | EN

gitlite — search

#hacktoberfest #react #ai #go #machine-learning #rust #deep-learning #linux #java #cli #kubernetes #openai #ios #mcp

exam-study-platform

(★ 2)

Self-hosted study platform for the BCS June 2026 resit window. Markdown notes + AI question banks + practice-exam grading for 5 courses.

exam-study-platform Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Exam Study Platform

A self-hosted study platform for the Maastricht BCS June 2026 resit window.
Bundled with chapter notes, mock exams, AI-generated question banks, and
flashcards for five courses:

- **BCS1520** — Statistics
- **BCS1540** — Algorithmic Design
- **BCS2410** — Embedded Programming
- **BCS2420** — Computer Security
- **BCS2540** — Numerical Methods

Built on Node (no framework), reads markdown straight from disk, generates
questions / grades attempts via your choice of Codex CLI, Claude CLI, or the
Anthropic API directly.

---

## Quick start

```bash
git clone https://github.com/davidwickerhf/exam-study-platform.git
cd exam-study-platform
npm install
npm run setup     # interactive: detects providers, picks one, seeds state
npm start         # serves at http://localhost:4177
```

That's it. `npm run setup` is idempotent — re-run any time to switch LLM
provider, paste a new API key, or reset cache directories.

After the first start, the only command you need to launch it again is:

```bash
npm start
```

## Prerequisites

- **Node.js 18+** — the server uses ESM and the global `fetch`. macOS users
  with [Volta](https://volta.sh/) or [nvm](https://github.com/nvm-sh/nvm) are
  set; otherwise grab a build from [nodejs.org](https://nodejs.org).
- **One LLM provider** — pick at setup time:
  - **Codex CLI** — Anthropic's desktop Codex app. Available from
    [anthropic.com/codex](https://www.anthropic.com/codex).
  - **Claude CLI** — `npm install -g @anthropic-ai/claude-code` then `claude login`.
  - **Anthropic API key** — Most universal option. Get one at
    [console.anthropic.com](https://console.anthropic.com/settings/keys);
    setup will prompt for it.

You can also use the platform with **no provider** — chapter reading and the
pre-generated question banks still work. Only question generation and
attempt-grading need an LLM.

## What you get out of the box

Everything below is shipped in the repo and ready to use immediately, no
generation required:

| Surface | Pre-loaded content |
|---|---|
| Chapter notes | ~50 chapters of markdown, every diagram inlined as SVG |
| Mock exam PDFs | 11 past papers across the 5 courses, with solutions where available |
| Tutorials (Computer Security only) | 8 tutorial sheets, with solutions where available |
| Practice exam parsing | All papers + tutorials pre-parsed into individual questions with model answers (~190 questions in the tutorials alone) |
| Mock question bank | 303 AI-generated questions across the 5 courses, tagged by chapter + topic |
| Flashcards | 743 cards across all 5 courses |
| PDF outlines | All shipped PDFs come with their content TOC pre-built |

You can regenerate or add to any of these via the platform's UI once an LLM
provider is configured.

## File layout

```
exam-study-platform/
├── content/                  # course materials (copied from vault)
│   ├── BCS1520 Statistics Knowledge Base/
│   ├── BCS1540 Algorithmic Design Knowledge Base/
│   └── ...
├── data/
│   ├── study-state.template.json   # ← committed: shared course definitions
│   ├── study-state.json            # ← gitignored: your progress
│   ├── flashcards.template.json    # ← committed: card content
│   ├── flashcards.json             # ← gitignored: your SR state
│   ├── llm-config.json             # ← gitignored: provider + API key
│   └── cache/                      # ← committed: generated content (questions, etc.)
├── public/                  # client JS/CSS
├── server.mjs               # the whole backend (~2000 lines)
├── setup.mjs                # interactive first-run setup
└── package.json
```

## Configuration

`setup.mjs` writes `data/llm-config.json`. You can also edit that file
directly. Recognised fields:

```jsonc
{
  "provider": "codex" | "claude" | "api",
  "codexBin": "/path/to/codex",                 // optional override
  "claudeBin": "claude",                        // optional override
  "anthropicApiKey": "sk-ant-…",                // required if provider=api
  "anthropicModel": "claude-sonnet-4-5"         // optional, defaults shown
}
```

Every field above also has an env-var override:

| Field | Env var |
|---|---|
| `provider` | `LLM_PROVIDER` |
| `codexBin` | `CODEX_BIN` |
| `codexModel` | `CODEX_MODEL` |
| `claudeBin` | `CLAUDE_BIN` |
| `anthropicApiKey` | `ANTHROPIC_API_KEY` |
| `anthropicModel` | `ANTHROPIC_MODEL` |

Env vars win over the config file. Useful for one-off testing:

```bash
LLM_PROVIDER=api ANTHROPIC_API_KEY=sk-ant-xxx npm start
```

## Pulling updates

When the maintainer adds new chapters or papers:

```bash
git pull
# Your data/study-state.json and data/flashcards.json keep your progress.
# New course definitions appear in the template; merge them manually if you
# want them in your working state (or rerun `npm run setup` and choose
# "overwrite" if asked).
```

The current template-merge story is intentionally manual — automating it
without trampling on personal progress is a future improvement.

## Privacy

Nothing leaves your machine except direct calls to the LLM provider you
configure. There is no telemetry, no analytics, no auth server. State lives
in flat JSON files under `data/`.

The shipped templates contain only course content — no personal attempts,
mistake history, or mastery scores.

## Maintainer notes

Re-syncing content from a source vault:

```bash
# Adjust the source path to wherever your Obsidian vault lives
rsync -a --delete \
  ~/Projects/personal/notes/University/June\ Exams/ \
  ./content/
```

`VAULT_ROOT` env var: if set, overrides `state.meta.vaultRoot`. Useful when
the maintainer wants the platform to read from the original vault instead of
the bundled `content/` directory while developing.

## License

Personal study material. Course PDFs belong to their respective course
coordinators at Maastricht; please don't redistribute beyond your study
group.

exam-study-platform

exam-study-platform Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

exam-study-platform

exam-study-platform Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README