diff options
| author |   Michael Lando <ml636r@att.com> | 2017-02-19 10:28:42 +0200 |
|---|---|---|
| committer | Michael Lando <ml636r@att.com> | 2017-02-19 10:51:01 +0200 |
| commit | 451a3400b76511393c62a444f588a4ed15f4a549 (patch) | |
| tree | e4f5873a863d1d3e55618eab48b83262f874719d /catalog-ui/SETTING-ENVIRONMENT.md | |
| parent | 5abfe4e1fb5fae4bbd5fbc340519f52075aff3ff (diff) | |
Initial OpenECOMP SDC commit
Change-Id: I0924d5a6ae9cdc161ae17c68d3689a30d10f407b
Signed-off-by: Michael Lando <ml636r@att.com>
Diffstat (limited to 'catalog-ui/SETTING-ENVIRONMENT.md')
| -rw-r--r-- | catalog-ui/SETTING-ENVIRONMENT.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/catalog-ui/SETTING-ENVIRONMENT.md b/catalog-ui/SETTING-ENVIRONMENT.md new file mode 100644 index 0000000000..edccca1304 --- /dev/null +++ b/catalog-ui/SETTING-ENVIRONMENT.md @@ -0,0 +1,36 @@ +# Prerequisites + +1. install [node.js](http://nodejs.org/download/) +2. install [git](http://git-scm.com/). __Make sure to select the option to add git into $PATH__ +3. install grunt with dependencies `npm install -g bower grunt-cli` + + if running on MacOS/Linux the command should be run with `sudo` + +# Running the server + +Make sure all the client and npm dependencies installed by running the following commands: + +1. `npm install` +2. `bower install` + + + +You are then presented with 3 options `ngnix`, `test`, `build` + +1. `grunt serve --env=mock` will setup a dev(nginx) server under `http://localhost:9000` with mock configurations. The are also `grunt serve:test` and `grunt serve:prod` options +2. `grunt test` will run all the unit tests in the project +3. `grunt build` will run a build process resulting with a `dist/` folder including the version ready to be deployed (this task should be mainly run on the CI server) +3. `grunt build:dev` will deploy to nginx a production artifact, (minify files) + +# Webstorm + +Although any text editor can be used to write angular applications Webstorm is the most convenient for the task. In case Webstorm is chosen make sure it has the following plugins: + +* `.editorconfig` - this plugin will keep line indentation same across all developers +* `angular.js` - this plugin will help autocompleting angular syntax +* `markdown` - this one will give nice support to write .md files such as this one you are reading right now + +These can be found in plugins settings section by pressing PC: `CTRL + SHIFT + A` MAC: `CMD + SHIFT + A` and typing addons + + +--> DO NOT COMMIT ANYTHING BEFORE RUNNING grunt build / grunt nginx / grunt nginx:mock --env=mock <-- |