bvandeusen
47e248d9ac
- 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>
47 lines
2.3 KiB
Markdown
47 lines
2.3 KiB
Markdown
# 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.
|
|
|
|
```bash
|
|
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](docs/architecture.md) | Stack, design decisions, data models, key services |
|
|
| [Configuration](docs/configuration.md) | Environment variables, Docker Compose, production setup, security |
|
|
| [Features](docs/features.md) | Detailed feature breakdown and keyboard shortcuts |
|
|
| [Development](docs/development.md) | Dev workflow, CI/CD, migrations, release process |
|
|
| [API Keys & MCP](docs/api-keys-and-mcp.md) | API key management and Fable MCP install guide |
|
|
| [SSO / OAuth](docs/sso-oauth.md) | OIDC setup for Authentik, Keycloak, and other providers |
|
|
| [Changelog](docs/changelog.md) | Development history |
|
|
|
|
## License
|
|
|
|
This project is privately maintained.
|