Web App · Docker · curl · Homebrew · AUR

Personal knowledge management system with gamification. Manage notes, goals, streaks, and skills through a web dashboard with AI-powered features.

---

Installation

Docker

git clone https://github.com/Axel-DaMage/joidy.git
cd joidy
cp .env.example .env
docker compose up -d

curl

curl -fsSL https://raw.githubusercontent.com/Axel-DaMage/joidy/main/scripts/install.sh | bash

Homebrew

brew tap Axel-DaMage/homebrew-tap
brew install joidy
joidy up

AUR

yay -S joidy
# or
paru -S joidy

---

Requirements

• Docker + Docker Compose

---

Configuration

Edit .env after cloning:

Variable	Description	Source
GEMINI_API_KEY	AI service key	Google AI Studio
OBSIDIAN_VAULT_PATH	Path to your Obsidian vault	e.g. /home/user/Documents/Obsidian
SECRET_KEY	Session signing key	Auto-generated on first setup

Optional:

GITHUB_TOKEN=          # GitHub sync
GITHUB_USERNAME=
TELEGRAM_BOT_TOKEN=    # Notifications
TELEGRAM_ALLOWED_USER_ID=

---

Usage

Service	URL
Web App	http://localhost:3000
API Docs	http://localhost:8000/docs

Development

make dev       # Hot reload, source mounts
make stop      # Stop all services
make logs      # View logs
make test      # Run tests
make migrate   # Database migrations

---

Architecture

.
├── api/              FastAPI REST backend
├── ai-service/       AI service (Gemini, OpenAI, etc.)
├── worker/           Background tasks (Obsidian sync, daily summaries)
├── frontend/         SvelteKit web application
├── data/             Database, uploads, vault
├── docker-compose.yml
└── Makefile

---

License

GNU General Public License v3.0. See LICENSE.