Data Ingest Board

For Local Development

Create a file called .env.local in /src with the same structure as example.env. Modify the variables as needed

Required services

The ingest-api must be running locally and you must change the variables GLOBUS_CLIENT_APP_URI and DATA_INGEST_BOARD_APP_URI to be http://localhost:3000/ for redirects to work properly. You can start the ingest-api with the following command:

$ ingest-api/src/python app.py

To start the application run the following commands inside /src:\ Note: This application requires Node.js 18 or later

$ npm install
$ npm run all

You can change the port of the app (and can subsequently change the py configs above to match) by running:

npm run dev -- -p 3001

Usage

This app provides a view of all current primary datasets and uploads. At a glance, users can see information about these entities such as Group Name, Last Modified, Title, and, importantly, Status. Toggle view between displaying Datasets and Uploads with the switch button. Each column can be sorted. Group Name, Status, Data Types, and Organ can be filtered by value for Datasets, and for organs, users can filter by Group Name and Status.

Authentication

Upon visiting the app, clicking "Log in with your institution credentials" will redirect users to Globus to chose their institution. Once logged in with their institution credentials, users will be redirected back to the page. HuBMAP/SenNet Read access is required to view the data.

Content Management

Banner

Currently, two locations offer adding a banner via adding/updating public/content/banners/index.json file without having to rebuild the image. To specify that both locations use the same banner, use the key default as property name. To use different banners per location, specify the property name login and/or searchEntities.

login Located before the Login section

{
  "login": {
    "content": "..."
  }
}

searchEntities Located right before the main search results area

{
  "searchEntities": {
    "content": "..."
  }
}

default This banner will be used for locations not specified.

{
  "default": {
    "content": "..."
  }
}

Configure the json object with the following properties: