readme updated
This commit is contained in:
parent
9240c36685
commit
11dd780b75
57
README.md
57
README.md
|
@ -4,50 +4,61 @@ One Paragraph of project description goes here
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
For testing purposes you will need to install globally the following items:
|
You will need to install globally the following items:
|
||||||
npm install -g karma
|
$ npm install -g karma
|
||||||
npm install -g karma-cli
|
$ npm install -g karma-cli
|
||||||
|
$ npm install -g gulp
|
||||||
## Getting Started // ### Installing
|
$ npm install -g webpack
|
||||||
|
|
||||||
Pull from repo.
|
|
||||||
|
|
||||||
install nodejs v6 or above.
|
|
||||||
|
|
||||||
install nginx globally.
|
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:
|
on root run:
|
||||||
npm install
|
$ npm install
|
||||||
gulp install
|
$ gulp install
|
||||||
|
|
||||||
lauching nginx:
|
lauching nginx:
|
||||||
./dev.sh
|
$ ./dev.sh
|
||||||
|
|
||||||
launching frontend:
|
launching frontend:
|
||||||
gulp client
|
$ gulp client
|
||||||
|
or start nginx before client on sequence
|
||||||
|
$ gulp clientDev
|
||||||
|
|
||||||
launching backend:
|
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
|
## Running the tests
|
||||||
|
|
||||||
for client-side unit tests run from project's root:
|
for client-side unit tests run from project's root:
|
||||||
karma start
|
$ karma start
|
||||||
|
|
||||||
for server-side unit tests run from project's root:
|
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
|
### Break down into end to end tests
|
||||||
|
|
||||||
on root run:
|
Run local database plus e2e paths:
|
||||||
|
$ gulp e2e
|
||||||
|
|
||||||
gulp docker
|
Just the e2e paths as the fixtures are untainted:
|
||||||
|
$ npm run e2e
|
||||||
wait 10 secs for db to be ready
|
|
||||||
|
|
||||||
npm run e2e
|
|
||||||
|
|
||||||
## Built With
|
## Built With
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue