mint/README.md

PCD-Suite的 Rust&React 重写版

目录

|目录|用途|备注| |-|-|-| |app|旧的项目目录|| |dashboard|前端代码|| |api|后端代码|| |documents|开发文档|| |docker|podman 启动脚本|| |font|网站所使用的字体|| |dicttext|字典数据文件csv格式|| |docker|podman 启动脚本|| |pali_title|三藏标题csv|更新csv文件后，运行install/***.php更新数据库| |phphtml|三藏原文数据|html格式，来自pced| |paliword|巴利文献单词表 |用三藏原文数据库导出的单词表生成|以后考虑服务器端生成|

安装

MacOS

cd mint; mkdir tmp; chown -R www:www tmp

然后进入 http://localhost/app/install 开始安装

开发

技术栈

前端

• react
• umijs
• ant design pro
• Tapescript

后端

• PostgreSQL
• elasticsearch
• golang
• Redis
  

工具

推荐使用 VSCode, 常用插件列表

• ESLint
• Rust(rls)
• Icons
• OneDark Pro
• Better Toml
• Prettier - Code formatter
• SQL Formatter

数据库管理工具

• 通用数据库管理工具-dbeaver
• redis图形界面工具-RedisDesktopManager

Git commit message 规范

git commit message格式 请参见 https://gitmoji.dev/

• 遵循 git pull request 流程
• 所有代码必须经过格式化
• 禁止提交测试中间数据、key、db 等文件
• Git commit message 格式
  • 每条 message 不超过一行
  • 每个 commit 应该是独立的一个 issue 任务
  • message 格式 :code: message body
  • code 定义
    • bug fix: :bug:
    • new feature: :construction:
    • document: :pencil:
    • ops: :rocket:
    • config file: :wrench:
    • test case: ::white_check_mark:

资源格式

• 文字统一使用markdown格式
• 图片
  • 尽量使用png格式
  • 如果是 svg 或 graphiz 绘图，附带源代码
  • 禁止使用未经授权的图片

部署

$ ssh-copy-id deploy@xxx.xxx.xxx.xxx
$ RUST_LOG=info axis -i staging -r deploy

文档

后端

• MinIO is a high performance object storage server compatible with Amazon S3 APIs
• Diesel: A safe, extensible ORM and Query Builder for Rust
• Actix web is a small, pragmatic, and extremely fast rust web framework

前端

• Pluggable enterprise-level react application framework
• Ant Desigh Pro
• Third-Party Libraries

Git

• About git pull request
• how to write a git commit message:
• An emoji guide for your commit messages