README.zh-CN.md

Pocket book

中文 | English

简介

Pocket book是一个免费开源的记账本应用程序，使用了最新的vue3，vite3，TypeScript等主流技术开发。

特性

• 最新技术栈： 使用 vue3、vite2 等前端前沿最新技术开发
• TypeScript：应用程序级 JavaScript 的语言
• 国际化：内置国际化方案

预览

文档

文档地址

准备

• node 和 git -项目开发环境
• Vite - 熟悉 vite 特性
• Vue3 - 熟悉 Vue 基础语法
• TypeScript - 熟悉TypeScript基本语法
• Es6+ - 熟悉 es6 基本语法
• Ant-Design-Vue - UI组件 基本使用

安装使用

• 获取项目代码

git clone https://github.com/thornboo/pocket-book

• 安装依赖

cd pocket-book

yarn install

• 运行

yarn serve

更新日志

CHANGELOG

项目地址

• pocket-book - 记事本

如何贡献

非常欢迎你的加入！提一个 Issue 或者提交一个 Pull Request。

Pull Request:

1. Fork 代码！
2. 创建自己的分支：git checkout -b feat/xxx
3. 提交您的分支：git commit -am 'feat(function): add xxx'
4. 推送您的分支：git push origin feat/xxx
5. 提交：pull request

Git 贡献提交规范

• 参考 vue规范 (Angular)

  • feat 增加新功能
  • fix 修复问题/BUG
  • style 代码风格相关无影响运行结果的
  • perf 优化/性能提升
  • refactor 重构
  • revert 撤销修改
  • test 测试相关
  • docs 文档/注释
  • chore 依赖更新/脚手架配置修改等
  • workflow 工作流改进
  • ci 持续集成
  • types 类型定义文件更改
  • wip 开发中

浏览器支持

本地开发推荐使用Chrome 90+ 浏览器

支持现代浏览器, 不支持 IE

相关仓库

如果这些插件对你有帮助，可以给一个 star 支持下吧

• vite-plugin-html - 用于 html 模版转换及压缩
• vite-plugin-style-import - 用于组件库样式按需引入
• vite-plugin-theme - 用于在线切换主题色等颜色相关配置
• vite-plugin-imagemin - 用于打包压缩图片资源

维护者

@thornboo

捐赠

如果你觉得这个项目对你有帮助，你可以帮作者买一杯咖啡表示支持!

License