Seiso UI
HTML JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
client
config
gulp
server
.gitignore
.jscsrc
.jshintrc
.travis.yml
Dockerfile
README.md
gulpfile.js
index.js
karma.conf.js
package.json
webpack.config.js

README.md

seiso-ui

Travis

Web UI for Seiso data.

This project is currently in progress and not ready for general use.

Seiso-ui is a Node.js web application with an Angular.js UI built with webpack and gulp.

The application server uses express.js for routing and passport for security. At build time, the server can house configuration for external API's that the UI can use or the server can use as a passthrough to those API's. This allows for the UI to be modular and pluggable.

Being a UI for, primarily, Seiso-api, angular controllers, directives and view partials are organized into components based on particular seiso entities. This convention, in addition to the build process established with gulp, follows those outlined in John Papa's Angular Style Guide.

Quick Dev Start

  1. Install dependencies.

    $ npm install

  2. Build client assets

    $ npm run build:dev

  3. Run Node server

    $ npm run start:dev

Rebuild on file change (would be used in place of step 2):

$ gulp watch

Build, watch, and browser-refresh with browser-sync:

$ npm run start:dev
$ gulp serve

(each of these commands would run as separate processes)

For additional build and run scripts check the scripts section of the package.json file.

Production Start

Build the static assets, then start the run script...

$ npm run start:prod

Running Tests

$ npm run test:server
$ npm run test:client

Coverage

$ npm run cover:server
$ npm run cover:client

Tools Used/Stack