github.com/celerforge/freenote @main

Freenote

一个支持 Markdown 的开源 AI 日记应用



<a href="https://freenote.app" style="display: inline-block; padding: 10px 20px; background-color: #4CAF50; color: white; text-decoration: none; border-radius: 5px; font-weight: bold;"><strong>访问 Freenote 应用</strong></a>






<a href="https://github.com/celerforge/freenote/issues/new?labels=bug&template=bug-report---.md">报告 Bug</a>
&middot;
<a href="https://github.com/celerforge/freenote/issues/new?labels=enhancement&template=feature-request---.md">请求新功能</a>

目录

1. 关于项目
2. 使用方法
3. 开始使用
   • 前提条件
   • 安装
4. 路线图
5. 贡献
6. 许可证
7. 联系方式

关于项目

Freenote 是一个支持 Markdown 的开源 AI 日记应用。您可以自由记录笔记，并借助 AI 助手轻松搜索和总结过去的条目，增强创意捕捉和管理能力。所有数据都存储在您的设备本地，确保隐私和安全。

主要特点

• Markdown 编辑器：丰富的格式化功能和直观的快捷键
• AI 助手：智能搜索和总结您的笔记
• 隐私优先：所有数据存储在您的设备本地
• 无干扰界面：专注于写作的简洁界面

(返回顶部)

使用方法

基本使用

1. 点击日记部分，使用 Markdown 编写笔记
2. 使用 Markdown 快捷键进行格式化：
3. 输入 # 到 ###### 创建标题（H1-H6）
4. 输入 * 或 - 创建项目符号列表
5. 输入 > 创建引用块
6. 选择文本 + Ctrl/Cmd+B 加粗，Ctrl/Cmd+I 斜体
7. 输入 ` 创建内联代码，或 ``` 创建代码块

AI 功能

1. 前往设置 → 添加您的 OpenAI API 密钥
2. 使用聊天功能询问有关您笔记的问题
3. 借助 AI 助手搜索所有条目

注意： AI 功能需要 OpenAI API 密钥

(返回顶部)

开始使用

按照以下简单步骤获取本地副本并运行。

前提条件

• Node.js（v18 或更高版本）
• npm 或 pnpm sh npm install npm@latest -g # 或 npm install -g pnpm

安装

1. 克隆仓库 sh git clone https://github.com/celerforge/freenote.git
2. 安装依赖 sh cd freenote pnpm install
3. 创建环境配置 sh cp .env.example .env
4. 启动开发服务器 sh pnpm dev

Docker 部署

您也可以使用 Docker 运行 Freenote：

1. 构建 Docker 镜像

sh docker build -t freenote .

1. 运行容器

sh docker run -p 3000:3000 freenote

1. 在 http://localhost:3000 访问应用

(返回顶部)

路线图

• [ ] 增强 AI 工具
• [ ] 关键词搜索的 AI 总结工具，显示相关笔记和连接
• [ ] 从笔记生成 AI 驱动的知识库
• [ ] 存储代码可读性优化
• [ ] 笔记导入/导出功能
• [ ] 多设备数据同步
• [ ] 使用 Tauri 添加桌面应用
• [ ] 添加笔记标签

查看未解决的问题获取完整的功能提议和已知问题列表。

(返回顶部)

贡献

贡献使开源社区成为一个令人惊叹的学习、启发和创造的地方。非常感谢您的任何贡献。

1. Fork项目
2. 创建您的功能分支（git checkout -b feature/AmazingFeature）
3. 提交您的更改（git commit -m 'Add some AmazingFeature'）
4. 推送到分支（git push origin feature/AmazingFeature）
5. 开启Pull Request

(返回顶部)

许可证

根据 AGPL-3.0 许可证分发。有关更多信息，请参阅 LICENSE。

(返回顶部)