蜜蜂🐝笔记 beenote

项目介绍

1. 基于vue3 + django rest framework 的markdown笔记软件
2. 由cursor协助开发
3. 欢迎提意见和需求
4. 近期将进行频繁更新，欢迎star、watch

功能定位

1. 个人笔记 和 公司内部知识分享
2. 用户分为普通用户、管理员用户、超级管理员三种角色
3. 用户角色可以创建笔记和笔记分组
4. 管理员可以看到全部用户的笔记和笔记分组，并可以为其他用户分配笔记和笔记分组权限
5. 超级管理员可以配置第三方登录
6. 用户只可以看到管理员授权的笔记和笔记分组

demo

https://beenote.huoxingxiaoliu.com/login?username=admin&password=mifengbiji
用户名：admin
密码：mifengbiji

Docker快速开始

创建docker-compose.yaml文件

生产建议打开数据库持久化

version: '3'

services:
  beenote:
    image: xtlyk/beenote:latest
    container_name: beenote
    # pull_policy: never  # 不自动拉取镜像
    ports:
      - "80:80"      # 前端端口
      - "8000:8000"  # 后端端口
    environment:
      - TZ=Asia/Shanghai
      - DEBUG=0
      - DJANGO_SETTINGS_MODULE=server.settings
      - SECRET_KEY=G2afcZy1EZwKIqZ61uV3Nhp1RInSTKZYiVXm5IzF
    # volumes:
    #   - /data/:/app/data/  # 数据库文件持久化，如开启数据库为初始空状态，需手动创建superuser
    restart: always
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000/api/auth/health/?format=json"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 40s

# 创建数据库持久化目录
# mkdir /data
docker compose up

浏览器打开

http://localhost

跟着火星小刘学运维开发

https://space.bilibili.com/439068477

qq群

欢迎加入beenote-笔记与知识仓库。

截图展示

开发环境

python 3.12
sqlite 3
django 5.1.4
node v22.12.0

部署安装

1. 拉取代码

git clone https://github.com/X-Mars/beenote.git

2. 初始化后端

cd beenote/server
pip3 install -r requirements.txt
python3 manage.py makemigrations
python3 manage.py migrate

3. 启动项目

python3 manage.py runserver

4. nginx 反向代理

location / {
  root /beenote/web/dist;
  index  index.html index.htm;
}

location /api {
  proxy_pass  http://localhost:8000;
  proxy_redirect     off;
  proxy_set_header   Host             $host;
  proxy_set_header   X-Real-IP        $remote_addr;
  proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for;
  proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;
  proxy_max_temp_file_size 0;
  proxy_connect_timeout      90;
  proxy_send_timeout         900;
  proxy_read_timeout         900;
  proxy_buffer_size          34k;
  proxy_buffers              4 32k;
  proxy_busy_buffers_size    64k;
  proxy_temp_file_write_size 64k;
}

后台地址

<http://ip:8000/admin>

默认用户名密码

用户名：admin 
密码： mifengbiji

License

996ICU License