diff --git a/README.md b/README.md index a8df77f6a..b54d06062 100644 --- a/README.md +++ b/README.md @@ -4,50 +4,61 @@ One Paragraph of project description goes here ### Prerequisites -For testing purposes you will need to install globally the following items: -npm install -g karma -npm install -g karma-cli - -## Getting Started // ### Installing - -Pull from repo. - -install nodejs v6 or above. +You will need to install globally the following items: +$ npm install -g karma +$ npm install -g karma-cli +$ npm install -g gulp +$ npm install -g webpack install nginx globally. -Ask a senior dev for the datasources.development.json files required to run the project. +## Getting Started // ### Installing + +Pull from repository. + +install nodejs v6. + +Ask a senior developer for the datasources.development.json files required to run the project. on root run: -npm install -gulp install +$ npm install +$ gulp install lauching nginx: -./dev.sh +$ ./dev.sh launching frontend: -gulp client +$ gulp client +or start nginx before client on sequence +$ gulp clientDev launching backend: -gulp services +$ gulp services +or start the local database before services on sequence +$ gulp serivcesDev + +Manually reset local fixtures: +$ gulp docker + +to check docker images and containers status: +$ docker images +$ docker ps -a ## Running the tests for client-side unit tests run from project's root: -karma start +$ karma start for server-side unit tests run from project's root: -npm run testWatch or test for single run +$ npm run test ### Break down into end to end tests -on root run: +Run local database plus e2e paths: +$ gulp e2e -gulp docker - -wait 10 secs for db to be ready - -npm run e2e +Just the e2e paths as the fixtures are untainted: +$ npm run e2e ## Built With