XNote

简体中文 | English | api-doc

简介

XNote 是一个开源 Web 端的 Markdown 笔记管理应用，支持在线编辑和预览 Markdown 笔记。

---

使用 Docker 部署

前端

docker run -d -it \
  -p 3000:3000 \
  --name xnote-nuxt \
  ghcr.io/xclhove/xnote-nuxt

• API_SERVER_URL: 后端 API 地址，如 “http://localhost:8080”。
• IPC: 备案号，如：“蜀IPC备-xxxxxxx号”。

后端

docker run -d -it \
  -p 8080:8080 \
  --name xnote-springboot \
  -v xnote-config:/app/config \
  ghcr.io/xclhove/xnote-springboot

---

技术栈

1. Vue3
2. Nuxt3
3. TypeScript
4. Vditor
5. Spring Boot
6. MyBatis-Plus
7. MySQL
8. MinIO
9. Elasticsearch

---

数据库表

git仓库

• 前端：xnote-nuxt(github) | xnote-nuxt(gitee)

• 后端：xnote-springboot(github) | xnote-springboot(gitee)

---

构建（后端）

需要安装 JDK 8 和 Maven。

1. 进入项目根目录，安装依赖：

   mvn clean install

2. 构建

   mvn package

3. 构建产物在target目录下，可直接部署到服务器：

   java -jar target/xnote-springboot-v<version>.jar

---

构建（前端）

需要安装 Node.js 和 Yarn。

1. 进入项目根目录，安装依赖：

   yarn install

2. 构建

   yarn build

3. 构建产物在.output目录下，可直接部署到服务器，启动.output/server/index.mjs即可：

   node ./output/server/index.mjs

环境变量（前端）

• API_SERVER_URL（必填）：后端 API 地址，如 “http://localhost:8080”。
• IPC（可选）： 备案号，如：“蜀IPC备-xxxxxxx号”。