Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nci-gdc/portal-ui
GDC Data Portal UI
https://github.com/nci-gdc/portal-ui
core d3 flow frontend jest react recompose redux relay
Last synced: about 1 month ago
JSON representation
GDC Data Portal UI
- Host: GitHub
- URL: https://github.com/nci-gdc/portal-ui
- Owner: NCI-GDC
- License: apache-2.0
- Created: 2014-10-02T15:39:36.000Z (over 10 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-08T17:35:13.000Z (11 months ago)
- Last Synced: 2024-04-13T23:53:53.213Z (10 months ago)
- Topics: core, d3, flow, frontend, jest, react, recompose, redux, relay
- Language: JavaScript
- Homepage: https://portal.gdc.cancer.gov/
- Size: 32 MB
- Stars: 18
- Watchers: 20
- Forks: 10
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
portal-ui was retired in June 2024
[](https://github.com/pre-commit/pre-commit)
---
#react #relay #redux #recompose #flow #jest #d3
- [Technologies](#technologies)
- [Installation](#installation)
- [Tests](#tests)
- [Development](#development)
- [Contributing](#contributing)
## Technologies
- [React](https://facebook.github.io/react/) - JavaScript library for building user interfaces
- [Relay](https://facebook.github.io/relay/) - JavaScript framework for building data-driven React applications
- [Redux](http://redux.js.org/) - Predictable state container for JavaScript apps
- [Recompose](https://github.com/acdlite/recompose) - React utility belt for function components and higher-order components
- [Flow](https://flow.org/) - Static type checker for JavaScript
- [Jest](https://facebook.github.io/jest/) - Delightful JavaScript testing
- [d3](https://d3js.org/) - Data-Driven Documents
* [Technologies](#technologies)
* [Installation](#installation)
* [Tests](#tests)
* [Development](#development)
* [Setup pre-commit hook to check for secrets](#setup-pre-commit-hook-to-check-for-secrets)
* [Contributing](#contributing)
## Installation
Install Watchman
```
brew update
brew install watchman
```
We recommend using **Node v8 (npm v5)**.
```
npm i
```
## Tests
```
npm test
```
## Development
By default the portal will attempt to connect to an api instance running on `localhost:5000`, however this can changed by setting the environment variable `REACT_APP_API`, or by setting `localStorage.REACT_APP_API` in the browser.
```
# start ui connected to localhost:5000 api server
npm start
# start ui connected to UChicago api server
REACT_APP_API=https://api.gdc.cancer.gov/v0/ npm start
// change api url during runtime in browser
localStorage.REACT_APP_API = 'https://api.gdc.cancer.gov/v0/'
```
## Setup pre-commit hook to check for secrets
We use [pre-commit](https://pre-commit.com/) to setup pre-commit hooks for this repo.
We use [detect-secrets](https://github.com/Yelp/detect-secrets) to search for secrets being committed into the repo.
To install the pre-commit hook, run
```
pre-commit install
```
To update the .secrets.baseline file run
```
detect-secrets scan --update .secrets.baseline
```
`.secrets.baseline` contains all the string that were caught by detect-secrets but are not stored in plain text. Audit the baseline to view the secrets .
```
detect-secrets audit .secrets.baseline
```
## Contributing
Read how to contribute [here](CONTRIBUTING.md)