WebUI Boilerplate

Installation

Create the following files:

package.json

1{
2  "scripts": {
3	"webui": "webui",
4	"install": "webui copy-engine && webui copy-libs"
5  },
6  "dependencies": {
7	"webui-cli": "~1.0.0",
8    "webui-boilerplate": "~1.0.1"
9  }
10}

webui.json

1{
2    "version": "~1.0.1",
3    "directory": "private/webui",
4    "publicDir": "public/webui",
5    "libDir": "public/lib",
6    "libs": []
7}

Run command:

npm install

File webui.json

Option	Description	Type	Required	Default
version	Default version of Boilerplate which is install when run webui install.	`string	null`	0
directory	Location where are copied engine files.	string	1	webui
publicDir	Location where are copied public files.	`string	null`	0
libDir	Location where are copied libraries.	`string	null`	0
libs	Table of libraries. Used to generate .requirejsrc file.	array	1	[]
package	Name of boilerplate package.	string	1	webui-boilerplate

Commands

Copy engine files.

npm run webui -- copy-engine

Copy libraries and build .requirejsrc.

npm run webui -- copy-libs

More informations in cli repo.

Libraries example

package.json

1{
2  // ..
3  "dependencies": {
4    // ..
5    "select2": "~4.0.0"
6  }
7}

webui.json

1{
2    // ..
3    "libs": [
4      // copy file from node_module/select2/dist/js/select2.full.min.js to lib/select2/select2.js
5      ["select2", "select2/dist/js/select2.full.min.js", "select2/select2.js"],
6      // copy directory from node_module/select2/dist/js/i18n to lib/select2/i18n
7      ["select2-i18n", "select2/dist/js/i18n", "select2/i18n"]
8    ]
9}

Tab index	Description	Type	Required
0	Name of RequireJS module.	string	1
1	Source file, files separated by comma or directory. fileconcat; fs-extra	string	1
2	Destination location.	string	1
3	Additional options separated by `	. Accepts option uglify` to minify dest.	string

How to initialize application

Call the startapp function with certain options e.g demo-init.js.

See the source code demo.

License

This library is under the LGPLv3 license. See the complete license in the file:

LICENSE