mirrors/sakura
1
0
Fork 0
mirror of https://github.com/mashirozx/sakura.git synced 2024-11-22 23:08:14 +08:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
mashirozx 2021-07-10 19:47:40 +08:00
parent 747a1c4f66
commit e9d5c98b6d
2 changed files with 31 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -1,36 +1,26 @@
# Vue 3 + Typescript + Vite # sakura-next
```bash ## Requirement
wget https://getcomposer.org/installer -O composer.phar
php composer.phar
mv composer.phar /usr/local/bin/composer
composer.phar install
curl -sS https://getcomposer.org/installer | php - PHP=7.4
- WordPress>=5.6.0
- Node.js>=14.17.1
- yarn>=1.22.10
## Commands
```sh
composer install # install php dependencies
yarn install # install node dependencies
yarn dev # run dev server
yarn build # build assets
yarn test # Jest test
yarn lint # eslint
yarn format # auto format
yarn i18n # export i18n variables
yarn rsync # sync backend app with server, see docs/dev.md
yarn composer # run `composer install` on remote server
yarn gen:icon # generate svg icon component
yarn remote-download:geoip2 # download GeoIP db on remote server
yarn local-download:geoip2 # download GeoIP db locally
``` ```
This template should help get you started developing with Vue 3 and Typescript in Vite.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur). Make sure to enable `vetur.experimental.templateInterpolationService` in settings!
### If Using `<script setup>`
[`<script setup>`](https://github.com/vuejs/rfcs/pull/227) is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) instead of Vetur (and disable Vetur).
## Type Support For `.vue` Imports in TS
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can use the following:
### If Using Volar
Run `Volar: Switch TS Plugin on/off` from VSCode command palette.
### If Using Vetur
1. Install and add `@vuedx/typescript-plugin-vue` to the [plugins section](https://www.typescriptlang.org/tsconfig#plugins) in `tsconfig.json`
2. Delete `src/shims-vue.d.ts` as it is no longer needed to provide module info to Typescript
3. Open `src/main.ts` in VSCode
4. Open the VSCode command palette
5. Search and run "Select TypeScript version" -> "Use workspace version"

8
docs/composer.md Normal file
View File

@ -0,0 +1,8 @@
```bash
wget https://getcomposer.org/installer -O composer.phar
php composer.phar
mv composer.phar /usr/local/bin/composer
composer.phar install
curl -sS https://getcomposer.org/installer | php
```