Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bcgsc/pori_ipr_client
Integrated Pipeline Reports (IPR) client. The web interface for the reporting application as part of PORI
https://github.com/bcgsc/pori_ipr_client
bioinformatics genomics personalized-medicine pori
Last synced: 7 days ago
JSON representation
Integrated Pipeline Reports (IPR) client. The web interface for the reporting application as part of PORI
- Host: GitHub
- URL: https://github.com/bcgsc/pori_ipr_client
- Owner: bcgsc
- License: gpl-3.0
- Created: 2020-12-17T19:24:58.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-08T21:57:36.000Z (7 days ago)
- Last Synced: 2024-11-08T22:34:05.400Z (7 days ago)
- Topics: bioinformatics, genomics, personalized-medicine, pori
- Language: TypeScript
- Homepage: https://bcgsc.github.io/pori
- Size: 17.6 MB
- Stars: 8
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Integrated Pipeline Reports (IPR) Client
   [](https://doi.org/10.5281/zenodo.5728424)
## Table of Contents
* [Running the client](#running-the-client)
* [Project structure](#project-structure)
* [Resources](#resources)
* [Contributing](#contributing)
IPR is part of the [platform for oncogenomic reporting and interpretation](https://github.com/bcgsc/pori).
The IPR client is designed to consume API data from IPR's API. The primary function is the production and management of various reports.
This project only includes the report functionality. Tracking and biopsy input are available in the IPR-Tracking application.
The client utilizes the React web framework. The UI library used is Material-UI (MUI) for React.
## Running the Client
Before running the client, the npm dependencies need to be installed:
```Bash
npm install
```
A dev version of the client can be run using:
```Bash
npm start
```
Dev in the above example can also be replaced by local or prod to run againt those APIs (local would be your own API instance).
Local environment will map API's to the machine's IP address and is meant to be used in parallel with a locally
running API server. After starting, the local web server will watch for changes on any files in the app and rebuild
the affected areas, then trigger the client (if open in browser) to reload.
The development environment maps API calls to the iprdev-api.bcgsc.ca API server that uses the separate development
database. This client is built automatically by the Bamboo CI server upon merging or committing/pushing to development
branch on the Bitbucket server.
The production environment maps API calls to the ipr-api.bcgsc.ca API server and uses the production database. This
is built automatically by the Bamboo CI upon approving a PR merge onto the production branch.
Other build options include `npm run build`. This will create the static files in the dist directory, but not
launch the local dev server.
## Project Structure
The app directory contains all of the application logic.
* `components` - Common components used across the application
* `views` - Page views which can be routed to
* `services` - React helper modules
* `styles` - General style related files and variables
* `statics` - Files and images not expected to change
* `utils` - Short helper functions
* `hooks` - Custom React hooks
* `context` - React contexts
## Resources
A demo site is available at https://pori-demo.bcgsc.ca
## Contributing
Contributions are welcome! Before doing so, please open an issue with the feature that would be added.
In addition, make sure that the code that is being added is linted using the rules in our .eslintrc file.