User interface for SIA event timeline
Перейти к файлу
Alberto Rodríguez 1b989f6353
SIA Chrome Extension Push Notifications (#78)
* SIA Chrome Extension Push Notifications
2018-02-22 17:08:34 -08:00
cfg SIA Chrome Extension Push Notifications (#78) 2018-02-22 17:08:34 -08:00
src SIA Chrome Extension Push Notifications (#78) 2018-02-22 17:08:34 -08:00
test SIA Chrome Extension Push Notifications (#78) 2018-02-22 17:08:34 -08:00
.babelrc SIA Chrome Extension Push Notifications (#78) 2018-02-22 17:08:34 -08:00
.deployment initial commit SIA event UI 2017-09-07 18:44:33 -07:00
.editorconfig initial commit SIA event UI 2017-09-07 18:44:33 -07:00
.gitignore SIA Chrome Extension Push Notifications (#78) 2018-02-22 17:08:34 -08:00
.travis.yml Move coverage to 'npm run test:coverage' instead of 'npm run test' (#79) 2018-02-13 09:32:45 -08:00
LICENSE Initial commit 2017-09-07 18:38:00 -07:00
README.md Documentation updates 2018-01-30 09:06:50 -08:00
app.js SIA Chrome Extension Push Notifications (#78) 2018-02-22 17:08:34 -08:00
deploy.cmd initial commit SIA event UI 2017-09-07 18:44:33 -07:00
jsconfig.json Code Maintenance (#65) 2018-01-17 13:11:36 -08:00
karma.conf.js Code Maintenance (#65) 2018-01-17 13:11:36 -08:00
package-lock.json SIA Chrome Extension Push Notifications (#78) 2018-02-22 17:08:34 -08:00
package.json SIA Chrome Extension Push Notifications (#78) 2018-02-22 17:08:34 -08:00
server.js Code Maintenance (#65) 2018-01-17 13:11:36 -08:00
webpack.config.js Code Maintenance (#65) 2018-01-17 13:11:36 -08:00

README.md

LICENSE Build Status Codacy Badge Coverage Status JavaScript Style Guide PRs Welcome

This is the user interface for SRE Incident Assistant (SIA)

See the Root repository for full project information and an overview of how services fit together.

SIA is built using:

SIA is configured for Wepback's hot module reloading, so changes should automatically appear in your browser.

Requirements

  • Node.js (latest LTS is preferred)

Before You Start

You will need to add const files in config for each environment you want to use; these are not tracked in git. See cfg/constExample.js for more details. Const files follow the naming convention $env.const.js (localhost.const.js is the const file loaded by localhost.js, for example).

Launch UI pointing at a local Gateway API

Use these steps to launch if you're hosting your Gateway API locally.

  • Navigate to the SIA-EventUI source directory root
  • Ensure your local copy of the gateway API is running on http://localhost:50000 (or the base URL you configured)
  • Enter these commands to launch the Event UI:
    npm install
    npm start
    
  • Navigate to http://localhost:3000

Launch UI pointing at a remote dev Gateway API

Use these steps if you're working on the Event UI and do not need to run a local copy of the gateway.

  • Create a localhost.const.js file inside the cfg folder. Use the cfg/constExample.js file as a template.
  • Navigate to the SIA-EventUI source directory root
  • Enter these commands to launch the Event UI:
    npm install
    npm run serve
    
  • Navigate to http://localhost:3000

To Test

  • Enter this command:
npm test

To create dist bundle, no server

webpack --env=dist

NPM scripts

A partial list of run scripts and what they do

Script What it does
start Launch the server and point at a gateway hosted on localhost (use localhost.const.js)
serve Launch the server and point at a gateway hosted in the dev environment (use dev.const.js)