This is the NextJS Application for BIH's data commons.

Getting Started

Gen3 Data Commons using the Gen3 Frontend Framework is a matter of the following:

Please see Styling and Theming and Local Development with Helm Charts for more information on setting up and configuring the Gen3 Data Commons Application. This documentation is currently less complete than we would like, but we will be adding to it as development progresses.

Installation for local testing

The minimum node version is set to v20.11.0 only from an LTS perspective. Node can be downloaded from the official Node.js site. You may also consider using a Node version manager. Your version of Node may not ship with npm v10. To install it, run:

npm install [email protected] -g

Note: if you see this error:

npm ERR! code ENOWORKSPACES
npm ERR! This command does not support workspaces.

you can run npx next telemetry disable

Alternatively, you can use nvm to install the correct version of npm:

nvm install 20.11.0

Install Dependencies

From the root of the project, install dependencies by running:

npm install

Run the Development Server

npm run dev

Open http://localhost:3000 with your browser to see the result.

Docker

You build a Docker image by: ,

docker build .

Staging and Production

The environment variable NEXT_PUBLIC_GEN3_API set in .env.production needs to be different for staging. There are two protected branches: main and staging. For staging, set the variable to: NEXT_PUBLIC_GEN3_API='https://bihstaging.data-commons.org' and ensure the "frontend-framework" value in manifest.json is set to:

"frontend-framework": "quay.io/cdis/bih-data-commons:staging",

Note this is temporary, and will be refined later, likely with a .env.staging file instead.