Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronConlon committed May 29, 2023
1 parent 82c13b0 commit e52c8f5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 12 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# create-juice-app

> 一个有趣的前端脚手架
`Create-juice-app`可以在`macOS``Linux``Windows`上运行,如果你在使用的时候遇到了任何问题,欢迎给我们提`issue`,如果你想要提问,也可以联系我们或者在`Github Discussions`上留言。

### 快速开始
### 快速开始

```bash
npx create-juice-app my-app
Expand All @@ -17,8 +18,6 @@ npm start

![](./img/1.gif)



### 模板

脚手架的原理是根据用户交互的信息,去拉取目标模板类型的样板项目代码进行初始化,我们会初始化一些通用的内容。诸如:
Expand All @@ -37,33 +36,28 @@ npm start
> 每一个脚手架我们都配置好一个基础的代码规范管理、格式化、插件设置、git 规范等功能
- [Juice](https://github.com/Developer27149/create-juice-app/blob/juice/README.md): `Vue3`生态下的服务端渲染解决方案,基于`TypeScript`+[Nuxt3](https://nuxt.com/)技术栈

- 状态管理使用的是[Pinia | The intuitive store for Vue.js](https://pinia.vuejs.org/)
- API数据管理使用的是[Vue-query](https://tanstack.com/query/v4/docs/vue/overview)
- API 数据管理使用的是[Vue-query](https://tanstack.com/query/v4/docs/vue/overview)
- 样式则使用`sass`[Tailwind CSS](https://tailwindcss.com/)
- 使用`nuxt-icon`方便创建 `svg icon`
- `eslint+prettier+commitlint+husky`
- Test

- React: 暂未完成



#### Juice

默认模板项目图示:

![](./img/juice.png)



### 参与开发

非常期待大家参与构建模板系统,你只需要创建一个新的分支即可。分支名就是你的模板名称。

或许你也需要稍微阅读一下脚手架的源代码(如果有任何建议、欢迎留言)



### License

本项目使用`MIT`许可证
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Juice-scaffold",
"name": "create-juice-app",
"version": "1.0.0",
"description": "An interesting front-end scaffold",
"main": "dist/index.js",
Expand Down
1 change: 0 additions & 1 deletion src/config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// 全局配置
export const globalConfig = {
scaffoldName: "juice-scaffold",
githubName: "Developer27149",
repo: "create-juice-app",
};

0 comments on commit e52c8f5

Please sign in to comment.