LyraNote

KO | EN

gitlite — search

#hacktoberfest #react #golang #machine-learning #rust #deep-learning #docker #macos #java #windows #awesome #awesome-list #security #openai

(★ 13)

LyraNote 是一款以 AI 为核心的研究笔记应用，面向知识工作者做“可检索的个人知识库 + AI 写作/研究助手”。

LyraNote Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1>LyraNote</h1>

<p><strong>Your AI-powered second brain — chat with your knowledge, not just store it.</strong></p>

**English** · [简体中文](./README.zh-CN.md)

[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]

</div>

<details>
<summary><kbd>Table of Contents</kbd></summary>

#### TOC

- [👋 Getting Started](#-getting-started)
- [✨ Features](#-features)
  - [Knowledge Management](#knowledge-management)
  - [AI Assistant](#ai-assistant)
  - [Rich Note Editing](#rich-note-editing)
  - [Smart Automation](#smart-automation)
- [🛠 Tech Stack](#-tech-stack)
- [🏗 Architecture](#-architecture)
- [🛳 Self Hosting](#-self-hosting)
  - [Option 1 — Local Development](#option-1--local-development)
  - [Option 2 — Docker Compose (All-in-one)](#option-2--docker-compose-all-in-one)
  - [Option 3 — Frontend on Vercel + Backend on Server](#option-3--frontend-on-vercel--backend-on-server)
- [⚙️ Environment Variables](#️-environment-variables)
- [⌨️ Quick Start](#️-quick-start)
- [🤝 Contributing](#-contributing)
- [📈 Star History](#-star-history)

####

<br/>

</details>

<br/>

## 👋 Getting Started

**LyraNote** is a modern, AI-powered personal knowledge management app designed to be your *second brain*. By integrating RAG (Retrieval-Augmented Generation), multi-step AI Agents, knowledge graphs, and long-term memory, LyraNote lets you truly *converse* with your own knowledge base — not just search through it.

---

## ✨ Features

### Knowledge Management

- **Multi-format Import** — Ingest PDF files, web URLs, and Markdown text; auto-parsed, chunked, and vectorized into your knowledge base.
- **RAG Conversations** — AI answers questions grounded in your notebook's knowledge base, with source citations.
- **Knowledge Graph** — Automatically extracts entities and relationships from sources and renders an interactive force-directed graph.

### AI Assistant

- **Streaming AI Chat** — Real-time SSE streaming with multi-turn context support.
- **Deep Research Agent** — Multi-step autonomous research: browses the web and produces structured research reports.
- **AI Copilot** — A floating AI panel docked beside the editor, always aware of your current notebook.
- **Inline Ghost Text** — AI suggestions appear inline as you type; press `Tab` to accept.
- **AI-Generated Content** — One-click generation of summaries, FAQs, study guides, briefings, and more.

### Rich Note Editing

- **Rich Text Editor** — Powered by Tiptap with Markdown shortcuts, headings, lists, code blocks, and blockquotes.
- **Auto-save** — Edits sync to the backend in real time.
- **Public Sharing** — Generate a read-only public link for any notebook.

### Smart Automation

- **Long-term Memory** — AI remembers user preferences and knowledge points across sessions for continuous personalization.
- **Scene Awareness** — Automatically detects conversation context (research / writing / learning / review) and adapts strategy.
- **Mind Maps** — Renders interactive mind maps directly inside AI chat.
- **Scheduled Tasks** — Create Cron jobs (daily news digests, knowledge briefings, etc.) with email delivery.
- **Proactive Insights** — AI proactively surfaces insight cards related to your current content.

---

## 🛠 Tech Stack

### Frontend (`web/`)

| Technology | Purpose |
|---|---|
| [Next.js 15](https://nextjs.org/) (App Router) | React full-stack framework |
| [React 19](https://react.dev/) + TypeScript | UI development |
| [Tailwind CSS](https://tailwindcss.com/) | Utility-first styling |
| [Tiptap](https://tiptap.dev/) | Rich text editor |
| [TanStack Query](https://tanstack.com/query) | Server-state management & caching |
| [Zustand](https://zustand-demo.pmnd.rs/) | Client-side global state |
| [Framer Motion](https://www.framer.com/motion/) | Animations |
| [react-force-graph-2d](https://github.com/vasturiano/react-force-graph) | Knowledge graph visualization |
| [markmap](https://markmap.js.org/) | Mind map rendering |
| [next-intl](https://next-intl-docs.vercel.app/) | Internationalization (i18n) |

### Backend (`api/`)

| Technology | Purpose |
|---|---|
| Python 3.12 + [FastAPI](https://fastapi.tiangolo.com/) | Async web framework |
| SQLAlchemy 2.0 + asyncpg | Async ORM |
| Alembic | Database migrations |
| PostgreSQL 16 + pgvector | Relational data + vector similarity search |
| Celery + Redis | Background async task queue |
| OpenAI SDK | LLM calls & text embeddings |
| [LangGraph](https://www.langchain.com/langgraph) | Multi-step Agent orchestration |
| MinIO / S3 | File object storage |
| Tavily API | Web search tool |

---

## 🏗 Architecture

```
┌─────────────────────────────────────────────────────────────────┐
│                         User Browser                            │
│          Next.js 15 Frontend (React 19 + Tiptap + Zustand)      │
└──────────────────────────────┬──────────────────────────────────┘
                               │ HTTP / SSE
┌──────────────────────────────▼──────────────────────────────────┐
│                   FastAPI Backend (Python 3.12)                  │
│   ┌─────────────┐  ┌──────────────┐  ┌───────────────────────┐  │
│   │  REST API   │  │  SSE Stream  │  │    Celery Worker      │  │
│   │   Routers   │  │  AI Chat     │  │  (Background AI Tasks)│  │
│   └──────┬──────┘  └──────┬───────┘  └──────────┬────────────┘  │
│          │                │                     │               │
│   ┌──────▼────────────────▼─────────────────────▼────────────┐  │
│   │                  Agent / Skills Layer                     │  │
│   │   ReAct Agent · RAG · Deep Research · Memory · KG · Write │  │
│   └──────────────────────────────────────────────────────────┘  │
└──────────────────────────────────────────────────────────────────┘
         │                    │                    │
┌────────▼──────┐   ┌─────────▼────────┐   ┌──────▼───────────┐
│  PostgreSQL   │   │      Redis       │   │   MinIO / S3     │
│  + pgvector   │   │ (Celery Broker   │   │  (File Storage)  │
│ (Data+Vector) │   │   + Cache)       │   │                  │
└───────────────┘   └──────────────────┘   └──────────────────┘
```

---

## 🛳 Self Hosting

### Option 1 — Local Development

Best for hot-reload debugging. The data layer (PostgreSQL + Redis) is managed by Docker; the application layer runs as local processes.

```bash
git clone https://github.com/LinMoQC/LyraNote.git
cd LyraNote
./lyra init     # interactive setup wizard — generates api/.env
./lyra local    # start local dev mode
```

The CLI automatically: detects/starts database containers → creates a Python venv → installs dependencies → runs DB migrations → starts FastAPI, Celery Worker, Celery Beat, and Next.js Dev Server in parallel.

Once local mode is up:
- **Frontend**: `http://localhost:3000`
- **Monitoring**: `http://localhost:3100/ops/login`
- **Backend API**: `http://localhost:8000`

Press `Ctrl+C` to stop local processes; database containers are unaffected.

---

### Option 2 — Docker Compose (All-in-one)

Runs everything — frontend, backend, worker, beat, and all infrastructure — in containers. Good for a quick full-stack preview or self-hosted server deployment.

**1. Configure environment variables**

```bash
./lyra init     # interactive wizard — generates api/.env with all required values
```

> Infrastructure connection strings (`DATABASE_URL`, `REDIS_URL`, `STORAGE_S3_*`) are already injected by the compose file — no need to set them in `.env`.

> **AI configuration** (API keys, models, etc.) is managed via the Setup Wizard on first launch, stored in the database. `.env` values act only as fallbacks.

**2. Start (development)**

```bash
./lyra docker   # start all services via Docker Compose
```

Once running:
- **Frontend**: `http://localhost:3000`
- **Backend API**: `http://localhost:8000`
- **API Docs**: `http://localhost:8000/docs`

```bash
./lyra logs     # tail live logs
./lyra stop     # stop all services
```

**3. Deploy to production server**

Use `docker-compose.prod.yml` for the app stack only. **Web and API are published on the host loopback** at `127.0.0.1:3000` and `127.0.0.1:8000` for **host Nginx** to reverse-proxy (see `nginx.system.example.conf`). Database/cache ports stay internal.

```bash
./lyra init     # select "production server" mode — generates root .env with domain + passwords
./lyra prod     # pull cloud images and start production stack
```

> The `init` wizard automatically generates a random `JWT_SECRET`, `POSTGRES_PASSWORD`, and `MINIO_ROOT_PASSWORD`, and writes them into the root `.env` consumed by `docker-compose.prod.yml`.

Open your domain (typically `https://your-domain.com` once TLS is configured) and complete the Setup Wizard.

---

### Option 3 — Frontend on Vercel + Backend on Server

Deploy the backend via Docker Compose on your server, and the frontend separately on Vercel.

**Backend (server)**

```bash
./lyra init     # generates root .env (choose "production server" mode)
docker compose -f docker-compose.prod.yml up -d db redis minio minio-init api worker beat
```

Open host Nginx ports `80`/`443` in your firewall. Do not expose `3000`/`8000` publicly; they are loopback-only.

**Frontend (Vercel)**

Add the following **Environment Variable** in your Vercel project dashboard:

| Variable | Value |
|---|---|
| `NEXT_PUBLIC_API_BASE_URL` | `https://your-server.com/api/v1` |

Push your code and Vercel will deploy automatically.

---

## ⚙️ Environment Variables

### Backend (`api/.env`)

In Docker Compose mode, infrastructure connection strings are injected by the compose file and do **not** need to be set in `.env`.

| Variable | Description | Required |
|---|---|---|
| `JWT_SECRET` | JWT signing key (`openssl rand -hex 32`) | ✅ |
| `GOOGLE_CLIENT_ID/SECRET` | Google OAuth | Optional |
| `GITHUB_CLIENT_ID/SECRET` | GitHub OAuth | Optional |

> AI-related config (`OPENAI_API_KEY`, `LLM_MODEL`, `EMBEDDING_MODEL`, `TAVILY_API_KEY`, storage backend, etc.) is stored in the database and managed via the **Setup Wizard** or Settings page. Values in `.env` act only as fallbacks.

### Frontend (`web/.env.local`)

| Variable | Description |
|---|---|
| `NEXT_PUBLIC_API_BASE_URL` | Backend API base URL (only needed for Vercel deployments) |

---

## ⌨️ Quick Start

**Option A — install globally once, then use `lyra` anywhere:**

```bash
npm install -g lyra-cli   # installs the lyra command globally
# or: cd scripts/lyra-cli && npm link

lyra init     # interactive wizard — generates .env
lyra docker   # start all services (Docker Compose)
lyra status   # check service health
lyra logs     # tail live logs
lyra stop     # stop everything
```

**Option B — no install, run directly from the repo root:**

```bash
git clone https://github.com/LinMoQC/LyraNote.git
cd LyraNote
./lyra          # interactive menu (uses Node.js, no npm install needed)
```

> **Requires Node.js ≥ 18** and Docker. Run `node --version` to verify.

---

## 🤝 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

---

## 📈 Star History

[![Star History Chart](https://api.star-history.com/svg?repos=LinMoQC/LyraNote&type=Date)](https://star-history.com/#LinMoQC/LyraNote&Date)

---

[github-contributors-shield]: https://img.shields.io/github/contributors/LinMoQC/LyraNote?color=c4f042&labelColor=black&style=flat-square
[github-contributors-link]: https://github.com/LinMoQC/LyraNote/graphs/contributors
[github-forks-shield]: https://img.shields.io/github/forks/LinMoQC/LyraNote?color=8ae8ff&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/LinMoQC/LyraNote/network/members
[github-stars-shield]: https://img.shields.io/github/stars/LinMoQC/LyraNote?color=ffcb47&labelColor=black&style=flat-square
[github-stars-link]: https://github.com/LinMoQC/LyraNote/stargazers
[github-issues-shield]: https://img.shields.io/github/issues/LinMoQC/LyraNote?color=ff80eb&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/LinMoQC/LyraNote/issues
[github-license-shield]: https://img.shields.io/badge/license-MIT-white?labelColor=black&style=flat-square
[github-license-link]: https://github.com/LinMoQC/LyraNote/blob/main/LICENSE

LyraNote

LyraNote Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

LyraNote

LyraNote Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README