resources_portal

Portal for pediatric cancer researchers to discover and manage sharing of resources like cell lines, datasets, scientific code, etc.

Resources Portal. Check out the project's documentation.

Prerequisites

• Docker

Optional

You can run the rportal command with ./bin/rportal from the root directory of this project. Optionally you can add this project's /bin folder to your path and then call it directly.

Local Development

Start the dev server for local development:

rportal  up

See the README for the API for more information and commands.

pre-commit can run linting on all committed files for you automatically on every commit. To enable this behavior, run pre-commit install in the root directory. This will require installing pre-commit if you have not already done so.

Cloud Development

The staging stack will be redeployed upon every merge to dev. The production stack has not yet been configured.

For instructions on how to deploy a development stack see the infrastructure README.

Testing

To populate the dev database with some realistic data, please run:

rportal populate-db

To clear the database, run:

rportal recreate-schema

See the README for the test data for a description of the test dataset.

Account Creation

Users can create accounts by signing in through ORCID using the button in the website's header. Accounts with associated grants can also be created by passing URL parameters to the /create-account endpoint, as documented in the account creation README.

ORCID OAUTH

Resources Portal uses ORCID OAUTH to create accounts and sign in users. You can find documentation for it in the OAUTH README.