refstack/refstack-ui/README.rst
Paul Van Eck c094c27eff Add results and test report page
This is the groundwork for the community results listing page
and the test run report page. The report page is fairly basic, primarily
showing how results stack up against defcore capabilities. Design is subject
to change, but this gets the ball rolling. A config.json.sample was also added.
The UI now expects a config.json in the root which will contain the
Refstack API URL.

Change-Id: Id7a376d0bccda5cbb5daf05e52a2c174ad40b497
2015-04-27 09:50:27 -07:00

41 lines
869 B
ReStructuredText

=======================
Refstack User Interface
=======================
User interface for interacting with the Refstack API.
Setup
=====
Create a config.json file and specify your API endpoint inside this file:
:code:`cp app/config.json.sample app/config.json`
You can start a development server by doing the following:
Install NodeJS and NPM:
:code:`curl -sL https://deb.nodesource.com/setup | sudo bash -`
:code:`sudo apt-get install nodejs`
From the Refstack project root directory, move into the UI folder:
:code:`cd refstack-ui`
Install dependencies and start the server:
:code:`npm start`
Doing this will automatically perform :code:`npm start` and :code:`bower install`
to get all dependencies.
By default, as noted in package.json, the server will use 0.0.0.0:8080.
Test
====
To run unit tests, simply perform the following:
:code:`npm test`