Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 1.71 KB

README.md

File metadata and controls

48 lines (37 loc) · 1.71 KB
Raw

w2ui-starter-es6

This repo is small, modular, easily extensible starting point to build apps with w2ui and ES6 Modules. Only modern browsers (ever-green: [latest, chrome, edge, firefox] and Safari 13+) support ES6 modules natively.

The purpose of this repo is to provide structure. It is a front-end framework, only few basic node based API files included. I have included latest version of w2ui in the src/libs folder.

NO EXTERNAL DEPENDENCIES - w2ui.es6.js (and w2ui.css) is all you need.

To get going:

npm install
npm start

File Structure

Your app should live in /src folder. This is where all front-end code is. You will find the following strucutre:

/app            - all front-end code is here
  /main         - layout and main menus
    conf.js     - main module config files
    main.js     - main module start point
    prefs.js    - main.prefs - to save preferences to local storage
  router.js     - tiny router, see description below
  routes.js     - for auto loading modules
  start.js      - starting point <--- START HERE
/less           - global less files
/icons          - svg files for icons and generated icon font
/libs           - 3d prath libs
global.css      - global css
global.less     - global less
index.html      - basic html

Gulp

Gulp is the task runner that can watch changes. It will compile you LESS files, icon-font and bundle up your application. If you run gulp without params it will compile LESS files in place. You can also run

gulp dev       # start watching .less and .svg files
gulp build     # bundles project into /build folder

See more: