Yireframe

Installation

Make sure you have nodejs & npm installed. Install all dependecies and run the webpack build script to generate the appilcation.

$ npm install
$ npm run build

The application can be found in the dist-folder. Just use your favorite HTTP-Server to serve the generated files.

Development Server

For development we highly recommend to use the webpack development server. Therefore just run the following command to start the server.

$ npm run start

Point your browser to http://localhost:8080/. The port can be changed in the webpack.dev.js-file.

Production Build

The production build does not contain any source map and the files are uglified.

$ npm run build:dist

Documentation Build

The documentation can be found in the doc-folder. Make sure to follow the Installation step to install jsDoc and other modules required.

$ npm run doc