README.md

🔱 atlantis

Self-hosted platform for Mermaid.js diagrams, notes, and knowledge management. Built with Next.js 16 (App Router), Tailwind CSS v4, and Shadcn UI.

---

Features

• Modern editor with live Mermaid preview and checkpoints (keeps 15 recent versions).
• Notes workspace with Markdown/LaTeX/code modes, interactive todo lists, tags, and search.
• Full Mermaid support plus SVG/PNG/PDF exports and favorites.
• Local persistence via SQLite (data/atlantis.db) with optional PostgreSQL/MySQL through env vars.
• Optional Redis cache; light/dark themes; backup/restore to JSON.

Walkthrough

Quick Start (Docker)

docker run -d -p 3000:3000 \
  -v $(pwd)/data:/app/data \
  --name atlantis \
  strikead/atlantis:latest

• Browse at http://localhost:3000
• Set ENABLE_API_ACCESS=true to expose /api/access/* and /docs.

Quick Start (Local Development)

Prerequisites: Node.js 18.18+ and npm 10+.

git clone https://github.com/Fantastic-Computing-Machine/atlantis.git
cd atlantis
npm install
cp .env.example .env
npm run dev

Scripts: npm run lint (ESLint), npm run build (type/check + Next build).

Documentation

• Contributing Guide: Dev setup, lint/build steps, LaTeX notes, Docker workflows.
• AI Doc: AI assistant configuration and usage.
• Container Startup & Deployment: Docker/Docker Compose and env vars.
• API Guide: Enable and use the REST API (/api/access/*).
• Notes Feature: Notes UX and related endpoints.
• Settings: UI settings and complete env var reference.

Data & Backup

Default storage: SQLite at data/atlantis.db (override with PRISMA_PROVIDER + DATABASE_URL/DB_CONNECTION).

• Backup: Settings → Backup downloads diagrams and notes as JSON.
• Restore: Settings → Restore accepts validated backup JSON.
• Checkpoints: Editor keeps up to 15 recent checkpoints per diagram.

License

MIT - see LICENSE for details.