Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.

Latest commit

 

History

History
89 lines (54 loc) · 3.06 KB

README.md

File metadata and controls

89 lines (54 loc) · 3.06 KB

RADAR-base Frontend Dashboard App

Build Status Codacy Badge Codacy Badge Coverage Status

An Angular and D3 web application to manage and monitor research data from the RADAR-base Platform.

Install

Install Node.js and Yarn.

We use angular-cli so you can use all of it's commands, like the generator. Please read its documentation for further information.

If want to use angular-cli's commands you need to install it globally:

$ yarn global add @angular/cli

In the project folder install npm dependencies:

$ yarn

To run the application use:

$ yarn start

Guidelines

Use the following command before commiting to fix common styling problems.

$ yarn fix:all

Contributing

Read /docs/CONTRIBUTING.md

Code of Conduct

Read /docs/CODE_OF_CONDUCT.md

Docker

Create docker image:

$ docker build -t radarbase/radar-dashboard ./

Or pull from dockerhub:

$ docker pull radarbase/radar-dashboard:latest

Run docker image locally:

$ docker run -d -p 3030:80 --name radar-dashboard radarbase/radar-dashboard:latest

The dashboard will be running at http://localhost:3030

Docker environment parameters

The environment parameters are set in docker run so they can be overridden by docker-compose. More information in https://docs.docker.com.

Change BASE_HREF if the application is running under a subfolder, e.g., https://radar-base.org/dashboard

BASE_HREF='/dashboard/'

Change API_URI to set the API endpoint of the application

API_URI='https://radar-backend.co.uk/api/'

Supporting Partners

We thank our supporting partners who have been a tremendous help in streamlining our development process.

Browserstack_logo