radarcns/radar-dashboard repository overview

⁠RADAR-CNS Frontend Dashboard App

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

⁠Install

Install Node.js⁠ and NPM⁠.

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:

$ npm i -g @angular/cli

In the project folder install npm dependencies:

$ npm i

To run the application use:

$ npm start

⁠Guidelines

For Typescript⁠ and Angular⁠ we loosely follow the Angular Style Guide⁠ and we use TSLint⁠ and Codelyzer⁠ to check these guidelines.

For SCSS⁠ we use StyleLint⁠, StyleFmt⁠ and PostCSS Sorting⁠ to format and lint the code.

Use the following command after you make changes to the SCSS and before a PR to run stylefmt and postcss-sorting and format the code.

$ npm run fix:css

⁠Contributing

Read /docs/CONTRIBUTING.md⁠

⁠Code of Conduct

Read /docs/CODE_OF_CONDUCT.md⁠

⁠Docker

Create docker image:

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

Or pull from dockerhub⁠:

$ docker pull radarcns/radar-dashboard:latest 

Run docker image locally:

$ docker run -d -p 3030:80 --name radar-dashboard radarcns/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-cns.org/dashboard

BASE_HREF='/dashboard/'

Change API_URI to set the API endpoint of the application

API_URI='https://radar-cns.ddns.net/api'

⁠Supporting Partners

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