Skip to content

docs: honest live-demo status + local run commands #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aimanmalib merged 1 commit into from
Oct 21, 2026
Merged

docs: honest live-demo status + local run commands #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![TypeScript](https://img.shields.io/badge/TypeScript-5-blue.svg)](https://www.typescriptlang.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)

**[Live demo →](https://learnpath-nine.vercel.app)** (bring your own API key: open **Settings**, pick a provider and paste a key)
**Live demo:** being redeployed with this version (bring your own API key). Until then, the screenshots below show the current build, and you can [run it locally](#development).

<table>
<tr>
Expand Down Expand Up @@ -126,6 +126,8 @@ LLM_MODEL=llama3.1
Requires Node.js 22.12 or newer.

```bash
npm ci # install
npm run dev # http://localhost:3000, then add your key in Settings
npm test # vitest
npm run typecheck # tsc --noEmit
npm run lint # eslint
Expand Down
Loading