README.md
Syllo
ZNS RoadMap Studio turns raw guides, playbooks, curricula, and notes into interactive learning workspaces. Paste content or upload a markdown file, let the AI structure it, and work through modules, tasks, resources, notes, and progress tracking in one place.
Features
- AI-powered parsing for roadmaps, playbooks, tutorials, strategies, and other structured content
- Interactive workspace with modules, milestones, notes, resources, videos, and progress tracking
- Local-first persistence — all data stays in your browser
- Markdown, JSON, and PDF export
- User-configurable AI provider, model, and API key
Stack
- Next.js App Router
- React 19
- TypeScript
- Tailwind CSS v4
Getting Started
- Install dependencies:
bash
| 1 | npm install |
- Create
.env.localwith the variables you need:
env
| 1 | # Access gate (password lock) - required |
| 2 | GATE_PASSWORD=change-me-to-a-strong-password |
| 3 | |
| 4 | # Optional: your own AI provider keys (used server-side for shared studio AI) |
| 5 | AI_PROVIDER=gemini |
| 6 | AI_API_KEY= |
| 7 | GEMINI_API_KEY= |
| 8 | OPENAI_API_KEY= |
| 9 | GROQ_API_KEY= |
| 10 | OPENROUTER_API_KEY= |
| 11 | NEXT_PUBLIC_APP_URL=http://localhost:3000 |
- Start the app:
bash
| 1 | npm run dev |
Scripts
npm run dev- start the local dev servernpm run build- run a production buildnpm run start- start the production servernpm run lint- run ESLintnpm run typecheck- run TypeScript without emitting files
Project Notes
- All data is stored locally in the browser (workspaces, notes, progress, credits).
- Custom AI keys are stored in browser storage and sent only to the selected provider when used.
- Optional server-side AI keys can be set in
.env.localfor shared studio AI.
Open Source
This repository is still in active development. Expect UI and schema changes while the workspace model evolves.