{"id":21988678,"url":"https://github.com/watish/breadnote","last_synced_at":"2025-04-30T11:14:04.803Z","repository":{"id":44426930,"uuid":"428274386","full_name":"Watish/BreadNote","owner":"Watish","description":"BreadNote是一款在线轻量笔记编辑平台，在浏览器访问即可使用不需要本地安装，方便快捷。","archived":false,"fork":false,"pushed_at":"2021-12-14T11:22:14.000Z","size":11173,"stargazers_count":8,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-30T11:13:28.645Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Watish.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-15T13:27:12.000Z","updated_at":"2024-06-30T11:08:07.000Z","dependencies_parsed_at":"2022-09-06T11:51:50.859Z","dependency_job_id":null,"html_url":"https://github.com/Watish/BreadNote","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Watish%2FBreadNote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Watish%2FBreadNote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Watish%2FBreadNote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Watish%2FBreadNote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Watish","download_url":"https://codeload.github.com/Watish/BreadNote/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251687147,"owners_count":21627532,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-29T19:21:10.910Z","updated_at":"2025-04-30T11:14:04.760Z","avatar_url":"https://github.com/Watish.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BreadNote V2.0\n\n## 简介\nBreadNote是一款在线轻量笔记编辑平台，在浏览器访问即可使用不需要本地安装，方便快捷。\n\n\n## 技术栈\n`PHP` `MixPHP` `Swoole` `Javascript` `React` `Mysql` \n#### 后端\n由PHP编写，使用国人编写的轻量级高性能框架MixPHP并利用swoole协程技术，提供restful规范的接口\n#### 前端\n由React编写，使用Ant Design，简约大气\n\n\n## 预览图\n\n![avatar](/storage/shortcut.png)\n\n\n## 安装\n\n\u003e 需要先安装 [Nginx](http://nginx.org/en/download.html) 、[PHP 7.4+](https://www.php.net/)、[MySQL 5.6+](https://www.mysql.com/)\n\n\n## 数据库配置\n配置文件 `/conf/config.json`\n\nBreadNote不会自动创建数据库，所以我们要在使用前创建配置文件\n\n```\n{\n    \"DATABASE_DSN\":\"mysql:host=数据库地址;port=端口;charset=utf8;dbname=数据库名\",\n    \"DATABASE_USERNAME\":\"数据库账号\",\n    \"DATABASE_PASSWORD\":\"数据库密码\"\n}\n```\n\n#\n## 快速开始\n\n由于笔记项目使用了swoole协程服务，我们不再支持php-fpm的启动方式\n\n\n启动 Swoole 协程服务\n\n```\ncomposer run-script --timeout=0 swoole:start\n```\n\n\n当然也可以直接下面这样启动，效果是一样的。\n\n```\nphp bin/swoole.php start\n```\n\n\n#\n## 使用Docker部署\n需要先部署一个MySQL容器，或者已安装好MySQL数据库\n```\ndocker run --name breadnote -d -p 80:80 -v /path/to/config.json:/app/conf/config.json -v /tmp/garbage/:/app/cahce/ --restart=always watish/breadnote:v2\n```\n\n### 配置文件映射\n```\n/path/to/config.json -\u003e /app/conf/config.json\n```\n### *映射内存空间给BreadNote缓存目录\n```\n/tmp/BreadNote -\u003e /app/cache\n```\n此方法可以有效防止笔记量增多后，或者高并发下的IO性能瓶颈，同时也能防止容器体积膨胀\n\n#\n##### 由于BreadNote使用swoole协程技术，我们不再需要浪费时间配置入口文件\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwatish%2Fbreadnote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwatish%2Fbreadnote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwatish%2Fbreadnote/lists"}