Skip to content

Add concise project overview to README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add concise project overview to README #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a771428
Initial plan
Copilot Feb 8, 2026
e90e330
docs: add project overview to readmes
Copilot Feb 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

Origin Notes is a local-first AI note app built with Electron + Vue 3 + Python. All data stays on your machine by default.

## Project Overview

- The Electron main process handles window/tray management, the SQLite store, image storage, and backups. The default data directory is `Documents/OriginNotes` (configurable in-app).
- The preload layer exposes IPC via `window.electronAPI`, and the renderer uses Vue 3 + Pinia + TipTap for the note UI.
- The AI backend is FastAPI + LangGraph on `127.0.0.1:8765`, handling chat, vector sync, and RAG search. The renderer calls it over HTTP.

## Key Features

### Notes
Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

Origin Notes 是一款本地优先的 AI 笔记应用，基于 Electron + Vue 3 + Python 构建，数据默认保存在本机。

## 项目概览

- Electron 主进程负责窗口/托盘、SQLite 数据库、图片存储与备份，数据目录默认在 `Documents/OriginNotes`（可在应用内迁移）。
- 预加载脚本通过 `window.electronAPI` 暴露 IPC 能力，渲染进程使用 Vue 3 + Pinia + TipTap 实现笔记 UI。
- AI 后端为 FastAPI + LangGraph，默认监听 `127.0.0.1:8765`，处理聊天、向量同步与 RAG 检索，前端通过 HTTP 调用。

## 核心功能

### 笔记
Expand Down