Get started
Run it locally
Page actions
- View as Markdown (opens in a new tab)
- Ask ChatGPT (opens in a new tab)
- Ask Claude (opens in a new tab)
ChatGPT and Claude are third-party services. The link gives them this page's public address and a short instruction. This site records nothing.
Preview: the published page may be older or missing.
From a fresh clone to the API, the website and this wiki running on your machine, with the gates CI runs — and what to do when a step fails.
https://docs.gurbanisoul.com/onboarding/run-it-locally/
Everything here runs on a laptop with no accounts and no network after the first download. The server is Python standard library only; the website and the wiki need Node.
1. Toolchain
| Tool | Version | Why |
|---|---|---|
| Python | 3.12 (.python-version) | the API, the tools, the gates. On macOS, Homebrew’s python3 is fine; avoid the system /usr/bin/python3 |
| Node | 22 (.nvmrc) | the website (frontend/) and the wiki (docs-site/) |
| git | any recent | the repository (no Git LFS is needed here — the database is installed by pin) |
| make | any | the entry points below |
git clone https://github.com/Algorythmos-AI/sggs-platform.gitcd sggs-platformmake doctor # checks python, node and whether the database is installed2. The database (pinned, verified)
The scripture database is not in this repository. dataset.lock.json names the sggs-data commit
and the sha256 of the exact object to serve; make dataset downloads it (~104 MiB), verifies the
checksum and size, and installs it atomically as db/sggs.sqlite (git-ignored).
make dataset # install db/sggs.sqlite from the pinmake dataset-check # prove sggs-data publishes that object at the pinned commit3. The API and the site
cd webapp && python3 serve.py# → http://localhost:7777 (override with SGGS_PORT)Open http://localhost:7777 for the prebuilt website served from webapp/static/, and check the
API is whole:
curl -s http://localhost:7777/api/health | python3 -m json.toolEvery value under checks must be true: 60,658 lines, 1,430 Angs, ੴ, the verifier alive. Then try a search and a page:
curl -s 'http://localhost:7777/api/search?q=sat%20nam&limit=3' | python3 -m json.toolcurl -s 'http://localhost:7777/api/ang/1' | python3 -m json.tool | head -40Every line comes back verbatim with its
4. The website source (optional)
cd frontend && npm ci && npm run dev # http://localhost:4321, calls the API on :7777npm run build:deploy # builds and syncs dist/ into webapp/static/5. This wiki
make docs-dev # http://localhost:4322 — live reload; /api proxied to serve.py on :7777make docs-check # the docs gates: frontmatter, links, widgets, palette, the scripture rulemake docs # full build with every Mermaid fence rendered and every link validated6. The gates CI runs
make ci # versions unified · dataset pin · platform tests · contract drift · docs gatesmake ci is the no-PDF subset of what a pull request runs; the scripture gates themselves run in
sggs-data. The full list, with what each check proves, is in CI gates.
When something fails
| Symptom | Cause | Fix |
|---|---|---|
db/sggs.sqlite missing — run: make dataset | fresh clone | make dataset |
/api/health has a false check | a partial or wrong database | make dataset-check, then make dataset again |
serve.py says a table is missing at startup | SGGS_MODULES set to a subset without its slice | unset it, or point SGGS_DB at a slice from make slices |
python3 is 3.9 or the system interpreter | macOS default on PATH | use Homebrew’s 3.12; make doctor tells you which one it found |
npm ci fails on a platform binary | node_modules copied from another machine | delete node_modules and run npm ci again |
| the wiki build says a Mermaid diagram failed | a syntax error in a fence | the message names the file and diagram; GitHub’s preview of the same fence helps |
| the wiki build cannot find Chromium | Playwright browsers not installed | cd docs-site && npx playwright install chromium |
More detail on the layout of the repository and the API is in Local setup, repository map & API.
Sri Guru Granth Sahib Ji — Knowledge Base wiki. Generated from commit c3d9360. Updated 25 September 2026. This copy may be out of date; the page is at https://docs.gurbanisoul.com/onboarding/run-it-locally/