简介

akir-tauri 是一个开源的, 基于 react、vite、 shadcn/ui、typescript、tauri 的桌面端开发脚手架，它使用了最新的前端技术栈，并提供了常用的客户端组件和软件基本结构，提升软件开发效率。

文档

待完善

准备

• Node 和 Git -项目开发环境
• Vite - 熟悉 Vite 特性
• React - 熟悉 React 基础语法
• Tauri - 熟悉 tauri 框架
• Zustand - 熟悉 zustand 基本使用
• TypeScript - 熟悉TypeScript基本语法
• Es6+ - 熟悉 es6 基本语法
• Mock.js - mockjs 基本语法

使用

方式 1:

• 安装 cli 工具

npm i akir-app -g

• 通过全局命令创建项目

akir-app

• 进入项目文件夹, 启动项目

cd [project_name]

pnpm install

pnpm dev

pnpm build

方式 2:

• 获取项目代码

git clone https://github.com/pomeluce/akir-tauri.git

• 安装依赖

cd akir-tauri

pnpm install

• 运行

pnpm dev

• 打包

pnpm build

如何贡献

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

Pull Request:

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

Git 贡献提交规范

• 参考 规范文档 (Angular)

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

浏览器支持

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

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

IE	Edge	Firefox	Chrome	Safari
not support	last 2 versions	last 2 versions	last 2 versions	last 2 versions