Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/initial setup #4

Merged
merged 5 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .env.development
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
GEN3_COMMONS_NAME=gen3
GEN3_COMMONS_NAME=heal
NEXT_PUBLIC_GEN3_API=https://localhost:3010
NEXT_PUBLIC_GEN3_DOMAIN=https://localhost:3010

# set these if you want to use different endpoints
#NEXT_PUBLIC_GEN3_GUPPY_API=
5 changes: 2 additions & 3 deletions .env.production
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
GEN3_COMMONS_NAME=gen3
NEXT_PUBLIC_GEN3_API=https://localhost/
NEXT_PUBLIC_GEN3_DOMAIN=https://localhost/
GEN3_COMMONS_NAME=heal
NEXT_PUBLIC_GEN3_API=https://localhost:3010
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@


This is the base REPOSITORY for Gen3.2 data commons.
This is the NextJS application for the HEAL Data Commons.


## Getting Started
Gen3 Data Commons using the Gen3 Frontend Framework is a matter of the following:
The HEAL Data Commons develop quick startup:

* create a clone of [Gen3 Data Commons Application](https://github.com/uc-cdis/commons-frontend-app/)  
* create a clone of [HEAL Data Commons](https://github.com/uc-cdis/heal-data-commons)

* Configure the commons by editing the configuration files in the ```config```

Expand All @@ -16,11 +16,11 @@ Gen3 Data Commons using the Gen3 Frontend Framework is a matter of the following

Changes to the Gen3 Data Commons Application can be pulled from the Common Frontend Repository. You need configure git to pull from the Common Frontend Repository.
```bash
git remote add upstream https://github.com/uc-cdis/commons-frontend-app.git
git remote add upstream https://github.com/uc-cdis/heal-data-commons.git
```
or
```bash
git remote add upstream [email protected]:uc-cdis/commons-frontend-app.git
git remote add upstream [email protected]:uc-cdis/heal-data-commons.git
```

changes to ```main``` can be pulled from the Common Frontend Repository by running:
Expand All @@ -34,12 +34,12 @@ This documentation is currently less complete than we would like, but we will be

## Installation

The minimum node version is set to v20.11.0 only from an LTS perspective.
The minimum node version is set to v20.71.0.
Node can be downloaded from the official Node.js site. You may also consider using a [Node version manager](https://docs.npmjs.com/cli/v7/configuring-npm/install#using-a-node-version-manager-to-install-nodejs-and-npm).
Your version of Node may not ship with npm v10. To install it, run:

```bash
npm install npm@10.2.4 -g
npm install npm@10.8.2 -g
```

Note: if you see this error:
Expand All @@ -51,7 +51,7 @@ you can run ```npx next telemetry disable```

Alternatively, you can use `nvm` to install the correct version of npm:
```bash
nvm install 20.11.0
nvm install 20.17.0
```

### Install Dependencies
Expand All @@ -78,3 +78,16 @@ You build a Docker image by:
```bash
docker build .
```

## Configuration

All the configuration files are located in ```config/heal```. As HEAL is currently only used for the landing page the
relevant configuration files are:

* navigation.json
* footer.json
* banner

## Custom Pages

See ```src/pages/SamplePage``` for an example of adding a new page to the HEAL commons.
9 changes: 0 additions & 9 deletions config/gen3/alternate_colors/dark.json

This file was deleted.

11 changes: 0 additions & 11 deletions config/gen3/alternate_colors/pallet2.json

This file was deleted.

9 changes: 0 additions & 9 deletions config/gen3/alternate_colors/urban.json

This file was deleted.

18 changes: 0 additions & 18 deletions config/gen3/footer.json

This file was deleted.

72 changes: 0 additions & 72 deletions config/gen3/navigation.json

This file was deleted.

5 changes: 0 additions & 5 deletions config/gen3/themeFonts.json

This file was deleted.

16 changes: 16 additions & 0 deletions config/heal/banner.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[
{
"message": "[View the latest studies that have shared data with the HEAL Data Platform!](/landing/newly-available-datasets)",
"level": "MESSAGE",
"dismissible": true,
"isExternalLink": false,
"id": 0
},
{
"message": "Our helpdesk has moved! Starting 8/21, please contact us at [[email protected]](mailto:[email protected])",
"level": "MESSAGE",
"dismissible": false,
"isExternalLink": false,
"id": 0
}
]
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading
Loading