快速开始

环境准备

TIP

如果你是纯小白，建议直接使用 Docker 快速安装。或根据下文部署指南进行部署。

你可以选择以下两种方式启动 BiliNote ：

方式一：本地运行

环境要求

• Python 3.10+
• Node.js 18+
• ffmpeg
• conda

git clone https://github.com/your-org/BiliNote.git
cd BiliNote

#  修改 .env 文件
cp .env.example .env

# 安装前端依赖
cd BillNote_frontend
npm install
npm run start

# 另开终端运行后端
cd ../backend
conda create -n bilinote-env python=3.10
conda activate bilinote-env  # 或你自定义的虚拟环境
python main.py

方式二：Docker 快速部署

环境要求

• Docker
• Docker Compose

WARNING

这里分为两个版本，最新版 即 Github 版本，该版本需要 docker-compose 构建镜像 稳定版 即已经构建好的版本。

最新版

git clone https://github.com/JefferyHcool/BiliNote.git
cd BiliNote
#  修改 .env 文件
cp .env.example .env
docker-compose up -d

稳定版

git clone https://github.com/JefferyHcool/bilinote-deploy.git
cd bilinote-deploy
#  修改 .env 文件
cp .env.example .env
docker-compose up -d

访问

部署成功后，访问 http://localhost:3015 或 .env 文件中配置的 FRONTEND_PORT 所指定的端口，即可访问 BiliNote。 若端口已被占用，可在 .env 文件中修改 FRONTEND_PORT 的值并重新部署。