omi/packages/omi-cli
dntzhang 2c6cd8c6f5 update version 2018-11-08 10:44:34 +08:00
..
bin omi-cli 3.0.10 2018-11-07 15:44:17 +08:00
lib omi-cli 3.0.10 2018-11-07 15:44:17 +08:00
template update cli template using latest omi 2018-11-08 10:44:05 +08:00
.eslintrc eslintrc (#93) 2018-10-22 12:39:56 +03:00
.gitignore standart code styling 2018-10-21 22:56:05 +03:00
.npmignore omi-cli 2018-10-19 08:04:39 +08:00
README.md update readme 2018-11-07 16:02:39 +08:00
package.json update version 2018-11-08 10:44:34 +08:00
yarn.lock omi-cli 2018-10-19 08:04:39 +08:00

README.md

CLI

$ npm i omi-cli -g               # install cli
$ omi init your_project_name     # init project, you can also exec 'omi init' in an empty folder
$ cd your_project_name           # please ignore this command if you executed 'omi init' in an empty folder
$ npm start                      # develop
$ npm run build                  # release

Directory description:

├─ config
├─ public
├─ scripts
├─ src
│  ├─ assets
│  ├─ elements    //Store all custom elements
│  ├─ store       //Store all this store of pages
│  ├─ admin.js    //Entry js of compilerwill build to admin.html
│  └─ index.js    //Entry js of compilerwill build to index.html

TypeScript Template(omi-cli v3.0.5+):

$ omi init-ts your_project_name  

SPA Template(omi-cli v3.0.10+):

$ omi init-spa your_project_name    

CLI's auto-created project scaffolding is based on a single-page create-react-app to be converted into a multi-page one, with configuration issues to see create-react-app user guide

About compiled website URL

Such as in windows:

"scripts": {
  "start": "node scripts/start.js",
  "_build": "node scripts/build.js",
  "build":"set PUBLIC_URL=https://fe.wxpay.oa.com/dv&& npm run _build"
}

In mac os:

"scripts": {
    "start": "node scripts/start.js",
    "_build": "node scripts/build.js",
    "build":"PUBLIC_URL=https://fe.wxpay.oa.com/dv npm run _build",
    "fix": "eslint src --fix"
  },

License

This content is released under the MIT License.