Skip to content

Updating README.md #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CalvinRodo wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Updating README.md #32

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb885be
Updating README.md
CalvinRodo Mar 14, 2019
0f75309
Adding API Project setup
s-laugh Mar 14, 2019
2a598fd
removing run tests from gui as it isn't needed
s-laugh Mar 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 56 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,49 @@
# 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
```
Copy link
Member

@s-laugh s-laugh Mar 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once I was actually able to get this running do to missing dependencies https://docs.cypress.io/guides/guides/continuous-integration.html#Advanced-setup
It's still gives me errors because it can't connect to http://localhost:4848 - I'm guessing the app needs to be run in docker first to run the test, so that should be mentioned here.

Copy link
Member Author

@CalvinRodo CalvinRodo Mar 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the readme

Copy link
Member

@s-laugh s-laugh Mar 18, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you push your change, i don't see it...

_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
Run the following command in the `app-hub-gui` folder.
```
npm install
```
Expand All @@ -15,25 +58,26 @@ npm run serve
npm run build
```

### Run your tests
```
npm run test
```

### Lints and fixes files
```
npm run lint
```

### Run your end-to-end tests
```
npm run test:e2e
```

### Run your unit tests
```
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
```