diff --git a/README.md b/README.md index da8f22c..be7a1e0 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ ## Introductions -The wails-template-vue template is a Vue template that supports Wails programs and provides Router and i18n functions by default. +The wails-template-vue template is a Vue template that supports [Wails](https://github.com/wailsapp/wails) programs and provides Router and i18n functions by default. @@ -94,6 +94,7 @@ I hope that Vue and its powerful community ecology can be used in Wails applicat - Built-in Sass preprocessor. - A consistent UI experience across platforms(Comes with JetbrainsMono font package). - Comes with a complete API example(Currently under development and testing...). +- Support JavaScript and TypeScript @@ -114,13 +115,18 @@ flag description: - n - The name of the application to be created - t - Template name, supports built-in template names and third-party templates in the form of hyperlinks -### Front-end reference document +After the project is created, the JavaScript template is used by default. You can change the value of the `"frontend:build"` field in the `wails.json` file to `"npm run build -w ts"` to use the TypeScript template. + +Note: In order to support TypeScript templates under the existing functions, the front-end part uses the NPM workspace function, so the NPM version must be `>=7.0.0`, please run `npm -v` to check your NPM version. + +### Reference document The front-end part uses Vue Vue-Router and Vue-I18N: - Vue - Use vue3.x version, please refer to the official [Vue3.x Documents](https://v3.vuejs.org/guide/introduction.html) for specific usage. - Vue-Router - Use Vue-Router 4.x version, please refer to the official [Vue-Router Documents](https://next.router.vuejs.org/) for specific usage. - Vue-I18N - Use Vue-I18N 9.x version, please refer to official [Vue-I18N Documents](https://vue-i18n.intlify.dev/) for specific usage. +- TypeScript - Please refer to official [TypeScript Documents](https://www.typescriptlang.org/) for specific usage. Then you can refer to the official [Wails document](https://wails.io) to start developing your application🤞. diff --git a/README.zh-Hans.md b/README.zh-Hans.md index 0ff5499..da28039 100644 --- a/README.zh-Hans.md +++ b/README.zh-Hans.md @@ -66,7 +66,7 @@ ## 项目介绍 -wails-template-vue 模板是一个支持 Wails 应用的 Vue 模板,默认提供路由和国际化功能。 +wails-template-vue 模板是一个支持 [Wails](https://github.com/wailsapp/wails) 应用的 Vue 模板,默认提供路由和国际化功能。 @@ -92,7 +92,8 @@ wails-template-vue 模板是一个支持 Wails 应用的 Vue 模板,默认提 - 支持单页路由和国际化 - 内置 Sass 预处理器 - 跨平台一致的 UI 体验(内置 JetbrainsMono 字体包) -- 附带完整的 APi 示例(目前正在开发测试中。。。) +- 附带完整的 API 示例(目前正在开发测试中。。。) +- 支持 JavaScript 和 TypeScript @@ -113,13 +114,18 @@ wails init -n [你的应用名称] -t https://github.com/misitebao/wails-templat - n - 将要创建的应用名称 - t - 模板名称,支持内置模板名称以及超链接形式的第三方模板 -### 前端部分参考文档 +项目创建以后,默认是使用 JavaScript 模板,你可以将`wails.json`文件中的`"frontend:build"`字段值修改为`"npm run build -w ts"`来使用 TypeScript 模板。 + +注意:为了在现有的功能下支持 TypeScript 模板,前端部分使用了 NPM 的工作区功能,所以 NPM 的版本必须`>=7.0.0`,请自行运行`npm -v`查看你的 NPM 版本。 + +### 参考文档 前端部分使用了 Vue Vue-Router 和 Vue-I18N。 - Vue - 使用 Vue 3.x 版本,具体使用方式请参考[Vue3.x 官方文档](https://v3.vuejs.org/guide/introduction.html)。 - Vue-Router - 使用 Vue-Router 4.x 版本,具体使用方式请参考[Vue-Router 官方文档](https://next.router.vuejs.org/)。 - Vue-I18N - 使用 Vue-I18N 9.x 版本,具体使用方式请参考[Vue-I18N 官方文档](https://vue-i18n.intlify.dev/)。 +- TypeScript - 具体使用方式请参考[TypeScript 官网文档](https://www.typescriptlang.org/)。 然后您就可以参考 [Wails 官方文档](https://wails.io)开始开发您的应用啦 🤞!