CLIC-Ethiopia/fad-wiki-os

LLM Wiki for STEAM-IE curriculum from FadLab smart industrial villages campus. # WikiOS WikiOS turns an Obsidian vault into a local web app. It lets you browse notes through a homepage, search, article pages, a graph view, and stats. Built by Ansub, co-founder of Supafast - we build websites for B2B SaaS & AI companies. ## What it does - Connects to an Obsidian-compatible markdown folder - Builds a local searchable index - Gives you a clean web interface for exploring your notes - Watches the vault for changes and updates the index automatically ## How to get started Clone and launch: ```bash git clone github.com wiki-os && cd wiki-os && npm run first-run ``` WikiOS will open in your browser and guide you through choosing a vault. You can also use the bundled demo vault on first run. ## Features - Homepage with featured notes, recent notes, and people highlights - Fast local search - Clean article pages - Graph view - Stats view - Manual reindex support - Automatic file watching - Local-first setup with no cloud requirement ### Docker You can run WikiOS with Docker if you want a simple container setup. This starts WikiOS with the bundled demo vault: ```bash docker compose up --build ``` The `docker-compose.yml` file is in the main project folder. By default, Docker uses the demo notes in `sample-vault/`. If you want to use your own Obsidian vault instead: 1. Open `docker-compose.yml` 2. Find this line: ```yml - ./sample-vault:/vault:ro ``` 3. Replace `./sample-vault` with the path to your own vault Example: ```yml - /Users/your-name/Documents/MyVault:/vault:ro ``` Leave `WIKI_ROOT: /vault` as it is. For a direct build and run: ```bash docker build -t wiki-os . docker run --rm -p 5211:5211 -e WIKI_ROOT=/vault -v /path/to/your/vault:/vault:ro -v wiki-os-data:/data wiki-os ``` ## Contributor mode For normal users, use: ```bash npm start ``` For contributors working on WikiOS itself, use: ```bash npm run dev ``` `dev` runs a split frontend/backend setup for faster iteration. ## Folder st …