diff --git a/README.md b/README.md index 759760b..ae5d6fb 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ # REX-Ray Configuration Generator -[http://rexrayconfig.thecodeteam.com](http://rexrayconfig.thecodeteam.com) +[https://rexrayconfig.herokuapp.com/](https://rexrayconfig.herokuapp.com/) ## Description A dynamically create [REX-Ray configurations](http://rexray.readthedocs.io/en/latest/user-guide/config/) based upon form inputs. ## Usage Instructions -Choose the service to add and begin filling out the forms. Angular.js will detect changes and automatically build out your `config.yml` used for REX-Ray. +Choose the service to add and begin filling out the forms. Angular.js will detect changes and automatically build out your `config.yml` used for REX-Ray. -At this time, only 1 service can be added and it's encouraged to validate using [yamllint](http://www.yamllint.com/). +At this time, only 1 service can be added and it's encouraged to validate using [yamllint](http://www.yamllint.com/). ## Future -- Add new service types as they are introduced in v0.10.X. +- Add new service types as they are introduced in v0.10.X. - New service forms are added using the `/services` folder -- Integrate pre-error checks for certain services where one value takes precedent over another. +- Integrate pre-error checks for certain services where one value takes precedent over another. - example. ScaleIO `System Name` vs `System ID`. - Add Modal/Tooltip/Popover for individual labels explaining what each means. [DONE] - This will cut down on the need to refer back to the documentation. @@ -23,7 +23,7 @@ At this time, only 1 service can be added and it's encouraged to validate using ## Contribution -To do local development, utilize `python -m SimpleHTTPServer`. +To do local development, utilize `npm install` and `npm start`. Create a fork of the project into your own reposity. Make all your necessary changes and create a pull request with a description on what was added or removed and details explaining the changes in lines of code. If approved, project owners will merge it diff --git a/package.json b/package.json index cebcfc8..6a90ddd 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,11 @@ "name": "rexrayconfig.thecodeteam.com", "description": "dynamically create rexray configurations", "version": "0.1.0", + "dependencies": { + "http-server": "^0.11.1" + }, "scripts": { - "test": "node test/faketest.js" + "test": "node test/faketest.js", + "start": "http-server" } }