This is the front end react application of Indoc Pilot project. The project was bootstrapped with Create React App.
- nodejs: ^16.13.2
- npm: ^9.1.2
install both npm and nodejs on https://nodejs.org/en/
run npm i on the ROOT/ folder to install all the dependencies.
if you are a developer, please additionally run npm run prepare to enable husky hooks
| Parameter | Description | Default |
|---|---|---|
| REACT_APP_PORTAL_PATH | root path for portal. you also need to update "homepage" in package.json to take effect | |
| REACT_APP_BRANDING_PATH | page path for your own branding page. logout/login/session expired | /login |
| REACT_APP_API_PATH | backend api endpoint for bff | |
| REACT_APP_UPLOAD_URL | backend api endpoint for upload service | |
| REACT_APP_DOWNLOAD_URL_V2 | backend api endpoint for download service v2 | |
| REACT_APP_DOWNLOAD_URL_V1 | backend api endpoint for download service v1 | |
| REACT_APP_DOWNLOAD_GR | url path for greenroom download service | |
| REACT_APP_DOWNLOAD_CORE | url path for greenroom core service | |
| REACT_APP_DEFAULT_AUTH_URL | url for keycloak auth | |
| REACT_APP_KEYCLOAK_REALM | keycloak realm | |
| REACT_APP_PLATFORM | Platform Name | Pilot |
| REACT_APP_DOMAIN | server domain | |
| REACT_APP_SUPPORT_EMAIL | user support email address | |
| REACT_APP_XWIKI | xwiki path for all document | |
| REACT_APP_DOC_BUCKET | public document path url prefix | |
| REACT_APP_SUPERSET_SUBDOMAIN | choose superset mode from subdomain / subpath | |
| REACT_APP_SUPERSET_SUBDOMAIN_BASE | fill the base domain if REACT_APP_SUPERSET_SUBDOMAIN is true | |
| REACT_APP_ENABLE_SELF_REGISTRATION | open the self-registration url | |
| REACT_APP_ORGANIZATION_PORTAL_DOMAIN | your organization domain |
run npm start to start the React application. You can access the webpage on localhost:3000 after it starts.
run npm build. After the compilation completed, the minimized static files are in ./build. You can use any other backend to serve these files.
The terms of use are in public/files/terms-of-use.html
Triggered on every push/PR to main. Builds Docker images for each environment in the matrix:
| Environment | Image tag suffix |
|---|---|
| hdc-lite | lite |
| ovh-dev | ovh-dev |
| ovh-prod | ovh-prod |
Images are pushed to both the eBRAINS Harbor registry and the OVH registry. On push to main (not PRs), the pipeline also:
- Creates a git tag from the version in
package.json - Triggers automatic deployment to dev by bumping
clusters/dev/versions.yamlin the gitops repo
Manual workflow_dispatch trigger. Go to Actions > Deploy to prod > Run workflow and enter the version (e.g. 1.7.8-hdc). The workflow appends -ovh-prod to produce the full image tag and bumps clusters/prod/versions.yaml in the gitops repo. ArgoCD picks up the change automatically.
The development of the HealthDataCloud open source software was supported by the EBRAINS research infrastructure, funded from the European Union's Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3) and H2020 Research and Innovation Action Grant Interactive Computing E-Infrastructure for the Human Brain Project ICEI 800858.
This project has received funding from the European Union’s Horizon Europe research and innovation programme under grant agreement No 101058516. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or other granting authorities. Neither the European Union nor other granting authorities can be held responsible for them.
