Fix case where ~/.ssh/id_rsa.pub is a softlink
[src/xds/xds-server.git] / webapp / README.md
1 XDS Dashboard
2 =============
3
4 This is the web application dashboard for Cross Development System.
5
6 ## 1. Prerequisites
7
8 *nodejs* must be installed on your system and the below global node packages must be installed:
9
10 > sudo npm install -g gulp-cli
11
12 ## 2. Installing dependencies
13
14 Install dependencies by running the following command:
15
16 > npm install
17
18 `node_modules` and `typings` directories will be created during the install.
19
20 ## 3. Building the project
21
22 Build the project by running the following command:
23
24 > npm run clean & npm run build
25
26 `dist` directory will be created during the build
27
28 ## 4. Starting the application
29
30 Start the application by running the following command:
31
32 > npm start
33
34 The application will be displayed in the browser.
35
36
37 ## TODO
38
39 - Upgrade to angular 2.4.9 or 2.4.10 AND rxjs 5.2.0
40 - Complete README + package.json
41 - Add prod mode and use update gulpfile tslint: "./tslint/prod.json"
42 - Generate a bundle minified file, using systemjs-builder or find a better way
43    http://stackoverflow.com/questions/35280582/angular2-too-many-file-requests-on-load
44 - Add SASS support
45    http://foundation.zurb.com/sites/docs/sass.html