diff --git a/README.md b/README.md index 147e3c0..386c6e9 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,26 @@ -# Vue 3 + Typescript + Vite +# sakura-next -```bash -wget https://getcomposer.org/installer -O composer.phar -php composer.phar -mv composer.phar /usr/local/bin/composer -composer.phar install +## Requirement -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 `