# beenote

**Repository Path**: xtlyk/beenote

## Basic Information

- **Project Name**: beenote
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-05-27
- **Last Updated**: 2025-11-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 蜜蜂🐝笔记 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文件  
**生产建议打开数据库持久化**

```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
```

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

## 浏览器打开

<http://localhost>

## 跟着火星小刘学运维开发

<https://space.bilibili.com/439068477>

## qq群

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

[![QQ群](https://pub.idqqimg.com/wpa/images/group.png)](https://qm.qq.com/cgi-bin/qm/qr?k=a_y5qjuIfBYZHkhGg4JTZqGjTk3KUI5T&jump_from=webapi&authKey=qJpb8UQWFJcxKBdT/zq9kGBqiMxOm9k3TkfYeAtaVtHAbKbIfxMiGBolmP+aWa5b)

[![QQ群二维码](https://github.com/X-Mars/beenote/blob/master/images/qrcode.jpg?raw=true)](https://qm.qq.com/cgi-bin/qm/qr?k=a_y5qjuIfBYZHkhGg4JTZqGjTk3KUI5T&jump_from=webapi&authKey=qJpb8UQWFJcxKBdT/zq9kGBqiMxOm9k3TkfYeAtaVtHAbKbIfxMiGBolmP+aWa5b)

[![B站火星小刘](https://github.com/X-Mars/Zabbix-Alert-WeChat/blob/master/images/5.jpg?raw=true)](https://space.bilibili.com/439068477)

## 截图展示

![登录页](https://raw.githubusercontent.com/X-Mars/beenote/refs/heads/master/images/1.png)
![仪表盘](https://raw.githubusercontent.com/X-Mars/beenote/refs/heads/master/images/2.png)
![笔记管理](https://raw.githubusercontent.com/X-Mars/beenote/refs/heads/master/images/3.png)
![笔记授权](https://raw.githubusercontent.com/X-Mars/beenote/refs/heads/master/images/4.png)
![三方登录](https://raw.githubusercontent.com/X-Mars/beenote/refs/heads/master/images/5.png)

## 开发环境

```shell
python 3.12
sqlite 3
django 5.1.7
node v22.14.0
```

## 部署安装

1. 拉取代码

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

2. 初始化后端

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

3. 启动项目

```shell
python3 manage.py runserver
```

4. nginx 反向代理

```conf
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;
}
```

## 后台地址

```url
<http://ip:8000/admin>
```

## 默认用户名密码

```conf
用户名：admin 
密码： mifengbiji
```

## License

[996ICU License](LICENSE)