liugq5713 / blade

目标

旨在打造自己顺手的工具库，并且以项目驱动学习

项目技术栈

本项目基于Electron，Node，React，Antd构建，图标库选用font-awesome，Eslint 规范选用airbnb，现在项目还未引入redux，当需要的时候自然会引入的。

文件结构

该项目的 UI 类似后台，公用的部分放在公用的部分，比如 src 文件夹下，公用的组件（components），公用的一些资源（assets），公用的功能函数（utils），作为开发者，当你有一个好点子，不妨你自己想做的功能则放置于 views 文件夹中（需在 views 文件夹中新建一个文件夹，你可以在你的文件夹下面随意操作）

src 文件夹

• index 则是整个应用的入口
• App.js 负责项目的布局
• routes/index.js 负责项目的路由
• assets 公共的资源
• components 公共的组件
• utils 公共的功能函数
• views 单个页面

eslint，babel 配置文件都在 package.json 文件中

目录结构

├── build
│   ├── webpack.common.js
│   ├── webpack.dev.js
│   └── webpack.prod.js
├── favicon.png
├── LICENSE
├── LICENSE.md
├── logo.svg
├── main.js
├── package.json
├── package-lock.json
├── README.md
├── src
│   ├── App.js
│   ├── assets
│   ├── components
│   ├── index.html
│   ├── index.js
│   ├── routes
│   │   └── index.js
│   ├── utils
│   └── views
│       └── ImageOptimizer
│           ├── FileSelect.js
│           └── index.js

工作流

执行操作请新开分支，分支命名规则如下：

• 特性分支： feat/add-feature@xxx
• 修复bug：fix/fix-bug@xxx

@xxx为项目开发者的代码，姓名缩写都行。比如 feat/add-some-feature@lgq

commit信息可以参考如下规范：

• feat: 新功能
• fix: 修复⼀一个bug
• docs: 只改了了⽂文档
• style: 修改不不涉及代码的主要逻辑 (如格式化了了代码)
• refactor: 改动了代码，既不不是新功能也不不是修复bug
• perf: 优化了代码，提升了了性能
• test: 增加或修改了代码测试
• build: 更改了构建流程相关的配置⽂文件和包(如glup, npm)
• ci: 更改了CI配置文件或脚本等(如Travis, Circle, BrowserStack, SauceLabs)
• chore: 其它不涉及源代码和测试代码的修改
• revert: git revert 一次提交

代码格式

IDE需安装editorconfig插件，统一提交代码的格式，具体配置如下：

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

其他

不要安装 sass