From fb885be0538b36bdde1c33a1226065f0f6cfc67c Mon Sep 17 00:00:00 2001 From: CalvinRodo Date: Thu, 14 Mar 2019 15:13:22 -0400 Subject: [PATCH 1/3] Updating README.md Added status badges Added information for running tests Removed info for running tests from GUI Section --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 44 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 701e953..bd85b72 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,48 @@ -# apphub +# AppHub -## Project setup +[![Known Vulnerabilities](https://snyk.io/test/github/esdc-devx/AppHub/badge.svg?targetFile=app-hub-api%2Fpackage.json)](https://snyk.io/test/github/esdc-devx/AppHub?targetFile=app-hub-api%2Fpackage.json) +[![Build Status](https://dev.azure.com/dx-team/AppHub/_apis/build/status/esdc-devx.AppHub?branchName=master)](https://dev.azure.com/dx-team/AppHub/_build/latest?definitionId=2&branchName=master) + +A dashboard for displaying information on systems department wide. + +## Run Integration and a11y Tests + +Run the following command in the `integration-tests` folder. + +### Setup Tests +``` +npm ci +``` + +### Run Tests +Run the following command to test the app in electron headless mode +``` +npx cypress run +``` +_If running locally a video copy of the tests will be put in `integration-tests/cypress/videos` to disable this functionality add the flag `--config video=false` when running tests_ + +Use the following command to view the tests in the Cypress Test Runner +``` +npx cypress open +``` + +## Run System + +The following command will build and bring up the API and GUI servers +``` +./start-system.sh +``` + +The following command will bring down the system +``` +./stop-system.sh +``` + + + + + +## GUI Project Setup Project setup ``` npm install ``` @@ -25,11 +67,6 @@ npm run test npm run lint ``` -### Run your end-to-end tests -``` -npm run test:e2e -``` - ### Run your unit tests ``` npm run test:unit From 0f75309cee69527ac1fcc6bb5956cf7eb5790e87 Mon Sep 17 00:00:00 2001 From: Shaun Laughland Date: Thu, 14 Mar 2019 16:11:52 -0400 Subject: [PATCH 2/3] Adding API Project setup --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bd85b72..2723f33 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,8 @@ The following command will bring down the system -## GUI Project Setup Project setup +## GUI Project Setup +Run the following command in the `app-hub-gui` folder. ``` npm install ``` @@ -74,3 +75,14 @@ npm run test:unit ### Customize configuration See [Configuration Reference](https://cli.vuejs.org/config/). + +## API Project setup +Run the following command in the `app-hub-api` folder. +``` +npm install +``` + +### Compile and hot-reloads for development +``` +node index.js +``` From 2a598fd41768b87c1bcd810a65ae8e19854783ba Mon Sep 17 00:00:00 2001 From: s-laugh Date: Fri, 15 Mar 2019 12:27:44 -0400 Subject: [PATCH 3/3] removing run tests from gui as it isn't needed --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 2723f33..396bfe8 100644 --- a/README.md +++ b/README.md @@ -58,11 +58,6 @@ npm run serve npm run build ``` -### Run your tests -``` -npm run test -``` - ### Lints and fixes files ``` npm run lint