X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=webapp%2FREADME.md;h=d543b03b301c35d639c11b83d2b9a88dceda657e;hb=2d3f1be6a495143d7e82f6396a49dfff6cabc3e4;hp=acee846e70be416132dfaaeba80653f78b428e3b;hpb=2d90eac319979dba64371258b30e61e77a15db7d;p=src%2Fxds%2Fxds-agent.git diff --git a/webapp/README.md b/webapp/README.md index acee846..d543b03 100644 --- a/webapp/README.md +++ b/webapp/README.md @@ -7,7 +7,21 @@ This is the web application dashboard for Cross Development System. *nodejs* must be installed on your system and the below global node packages must be installed: -> sudo npm install -g gulp-cli +> sudo npm install --global @angular/cli + +This project has been developed using [Visual Studio Code](https://code.visualstudio.com/download). Here is the list of +recommended VSCode plugins that are used to improved quality of written code : + +- ext install HookyQR.beautify +- ext install Mikael.Angular-BeastCode +- ext install eg2.tslint +- ext install streetsidesoftware.code-spell-checker +- ext install DavidAnson.vscode-markdownlint + +And some others useful plugins: + +- ext install patrys.vscode-code-outline +- ext install eamodio.gitlens ## 2. Installing dependencies @@ -15,7 +29,7 @@ Install dependencies by running the following command: > npm install -`node_modules` and `typings` directories will be created during the install. +`node_modules` directory will be created during the install. ## 3. Building the project @@ -32,14 +46,3 @@ Start the application by running the following command: > npm start The application will be displayed in the browser. - - -## TODO - -- Upgrade to angular 2.4.9 or 2.4.10 AND rxjs 5.2.0 -- Complete README + package.json -- Add prod mode and use update gulpfile tslint: "./tslint/prod.json" -- Generate a bundle minified file, using systemjs-builder or find a better way - http://stackoverflow.com/questions/35280582/angular2-too-many-file-requests-on-load -- Add SASS support - http://foundation.zurb.com/sites/docs/sass.html \ No newline at end of file