Skip to content

Commit

Permalink
Update readme with running locally details
Browse files Browse the repository at this point in the history
  • Loading branch information
AllenBW committed Jan 4, 2021
1 parent 5a85448 commit 65820f5
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# yara-frontend

Yarap for Red Hat Insights products that includes Patternfly 4 and shared cloud.redhat.com utilities.
Yara for Red Hat Insights products that includes Patternfly 4 and shared cloud.redhat.com utilities.

## Getting Started

Expand All @@ -28,13 +28,6 @@ Note: You will need to set up the Insights environment if you want to develop wi
- You are only notified on successful builds if the build before it failed
- By default, both `push` events as well as `pull_request` events send notifications
- Travis is defaulted to notify #insights-bots

### Sitemap

- When you run the build it also triggers sitemap generation and `sitemap.xml` is created.
- You need to have `routes` configured in `package.json` otherwise sitemap will be empty.
- For example see `package.json` here or in [insights-rbac-ui](https://github.com/RedHatInsights/insights-rbac-ui/blob/master/package.json)

## Deploying

- The Platform team is using Travis to deploy the application
Expand All @@ -47,6 +40,5 @@ Have [insights-proxy](https://github.com/RedHatInsights/insights-proxy) installe
SPANDX_CONFIG="./profiles/local-frontend.js" bash $PROXY_PATH/scripts/run.sh
```

### Testing - jest
Have [yara-backend](https://github.com/RedHatInsights/yara-backend) installed and run ```docker-compose up```

When you want to test your code with unit tests please use `jest` which is preconfigured in a way to colect codecoverage as well. If you want to see your coverage on server the travis config has been set in a way that it will send data to [codecov.io](https://codecov.io) the only thing you have to do is visit their website (register), enable your repository and add CODECOV_TOKEN to your travis web config (do not add it to .travis file, but trough [travis-ci.org](https://travis-ci.org/))

0 comments on commit 65820f5

Please sign in to comment.