bvandeusen 47e248d9ac docs: restructure documentation into docs/ directory, slim README, add project .mcp.json
- README.md: reduced to overview + quick start + links to docs/
- docs/architecture.md: stack, design decisions, data models, key services
- docs/configuration.md: all env vars, docker-compose setup, production + security
- docs/development.md: dev workflow, CI/CD, migrations, release process
- docs/features.md: detailed feature breakdown + keyboard shortcuts
- docs/api-keys-and-mcp.md: API key management + Fable MCP install guide
- docs/sso-oauth.md: OAuth/OIDC setup (replaces docs/oauth-setup.md)
- docs/changelog.md: development history from summary.md
- Remove summary.md (content distributed across docs/)
- Remove docs/oauth-setup.md (superseded by docs/sso-oauth.md)
- .gitignore: add .mcp.json

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-24 21:03:15 -04:00

Fabled Assistant

A self-hosted second brain and project management application with integrated LLM capabilities. Write, organise, and act on your notes and tasks with the help of a local AI assistant — all running on your own hardware.

Features

  • Notes — Markdown editor (Tiptap), wikilinks, backlinks, tags, version history, AI writing assist
  • Tasks — Status, priority, due dates, sub-tasks, milestones, work logs
  • Projects — Kanban view, milestone progress, three-panel project workspace (tasks / chat / notes)
  • AI Chat — SSE streaming, RAG, tool calls (create/update content, search web, check weather, calendar)
  • Daily Briefing — Scheduled digest of tasks, calendar, weather, and RSS; interactive follow-up conversation
  • Knowledge Graph — D3 force-directed graph of all notes and tags
  • Sharing — Share projects and notes with users or groups at viewer/editor/admin permissions
  • Fable MCP — MCP server for Claude and other clients to read/write your data via API keys
  • PWA — Installable, push notifications, web and Android companion app

Quick Start

Prerequisites: Docker and Docker Compose. 8 GB+ RAM recommended for LLM inference.

git clone https://git.fabledsword.com/bvandeusen/FabledAssistant.git
cd FabledAssistant
cp .env.example .env          # Edit .env to set SECRET_KEY
docker compose up --build

Open http://localhost:5000. The first user to register becomes admin.

Go to Settings → General to pull an LLM model. qwen3:8b or llama3.1:8b are good starting points.

Documentation

Doc Contents
Architecture Stack, design decisions, data models, key services
Configuration Environment variables, Docker Compose, production setup, security
Features Detailed feature breakdown and keyboard shortcuts
Development Dev workflow, CI/CD, migrations, release process
API Keys & MCP API key management and Fable MCP install guide
SSO / OAuth OIDC setup for Authentik, Keycloak, and other providers
Changelog Development history

License

This project is privately maintained.

S
Description
No description provided
Readme 14 MiB
v26.06.03 Latest
2026-06-03 12:51:04 -04:00
Languages
Python 53.7%
Vue 38.1%
TypeScript 5.8%
CSS 1.4%
Shell 0.8%