This is the NextJS Application for VPODC

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

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:

If using NVM run

nvm use

Otherwise

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 .

Updating a forked commons

To update a forked commons, the following steps usually apply.

Get the changes from the parent fork:

git remote add upstream [email protected]:uc-cdis/commons-frontend-app.git 
git fetch upstream

Create a branch and merge changes from upstream:

git merge upstream/main

You will see merge conflicts. In general: take the remote's version for everything except the config files, as those are customized to the commons config. Resolve the remaining config issues and open a PR. Test the new common by running it locally or in a staging environment.