RADAR-base/RADAR-Dashboard

Name: RADAR-Dashboard

Owner: RADAR-CNS

Owner: RADAR-CNS

Description: Dashboard for RADAR-CNS

Created: 2016-08-30 13:04:24.0

Updated: 2017-11-02 09:41:40.0

Pushed: 2018-01-12 17:31:32.0

Homepage: https://radar-cns.org/

Size: 3690

Language: TypeScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

RADAR-CNS 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-CNS 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:

rn global add @angular/cli

In the project folder install npm dependencies:

rn

To run the application use:

rn 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.

rn fix:css
Contributing

Read /docs/CONTRIBUTING.md

Code of Conduct

Read /docs/CODE_OF_CONDUCT.md

Docker

Create docker image:

cker build -t radarcns/radar-dashboard ./

Or pull from dockerhub:

cker pull radarcns/radar-dashboard:latest

Run docker image locally:

cker 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

_HREF='/dashboard/'

Change API_URI to set the API endpoint of the application

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.

Browserstack_logo

RADAR-CNS 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-CNS 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:

rn global add @angular/cli

In the project folder install npm dependencies:

rn

To run the application use:

rn 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.

rn fix:css
Contributing

Read /docs/CONTRIBUTING.md

Code of Conduct

Read /docs/CODE_OF_CONDUCT.md

Docker

Create docker image:

cker build -t radarcns/radar-dashboard ./

Or pull from dockerhub:

cker pull radarcns/radar-dashboard:latest

Run docker image locally:

cker 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

_HREF='/dashboard/'

Change API_URI to set the API endpoint of the application

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.

Browserstack_logo


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.