NOTEDASHBOARD
farismasud

obsidian-dashboard

Obsidian Dashboard

High-end web dashboard for your local Obsidian vault. Inspired by Rowboat.

Stack Stack Stack

Features

  • Dashboard — vault stats, recent notes, folder breakdown
  • Projects — card view of all notes in Projects/ folder
  • Knowledge — browse and read notes with rendered markdown + backlinks
  • Graph View — interactive galaxy/constellation force graph with glowing nodes
  • Search — full-text search across all notes
  • Dark / Light theme toggle
  • Live reload — vault changes in Obsidian reflect in the dashboard automatically (WebSocket)

Tech Stack

LayerTech
APIGolang + Gin + gorilla/websocket
File watchfsnotify
Markdowngoldmark
FrontendNext.js 16 + shadcn/ui + Tailwind
Graphreact-force-graph-2d
Themenext-themes

Setup

Prerequisites

  • Go 1.21+
  • Node.js 18+
  • An Obsidian vault at ~/Documents/Obsidian Vault/ (configurable via VAULT_PATH env)

Run

Terminal 1 — API:

cd api
go run main.go
# Running on http://localhost:8080

Terminal 2 — UI:

cd web
npm install
npm run dev
# Running on http://localhost:3000

Open localhost:3000.

Custom vault path

VAULT_PATH=/path/to/your/vault go run main.go

API Endpoints

MethodPathDescription
GET/api/notesAll notes with metadata
GET/api/note/*pathSingle note (rendered HTML)
GET/api/projectsNotes in Projects/ folder
GET/api/graphGraph nodes + edges
GET/api/search?q=Full-text search
GET/api/statsVault statistics
WS/wsLive vault change events

Related

How to Install

  1. Download the dashboard markdown file from GitHub
  2. Drop it into your vault (anywhere)
  3. Install the Homepage plugin and point it at the file
  4. Enable any listed CSS snippets for the intended look

Stats

Stars

0

Forks

0

Last updated 2mo ago

Categories