Skip to content

WISCENTD-UPC/idashboard

 
 

Repository files navigation

Build Status Commitizen friendly dependencies Status devDependencies Status

Interactive dashboard 2.1

Interactive dashboard App for DHIS2 with simple design and improved performance

This project was generated with Angular CLI version 1.7.4

Setup

Run npm run setup to install all required dependencies for the app

Development server

Run npm start for a dev server. Navigate to http://localhost:4200/.

This command will require proxy-config.json file available in the root of your source code, usually this file has this format

{
  "/api": {
    "target": "https://play.dhis2.org/2.29/",
    "secure": "false",
    "auth": "admin:district",
    "changeOrigin": "true"
  },
  "/": {
    "target": "https://play.dhis2.org/2.29/",
    "secure": "false",
    "auth": "admin:district",
    "changeOrigin": "true"
  }
}

We have provided proxy-config.example.json file as an example, make a copy and rename to proxy-config.json

Code documentation

To automatically generate documentation for the codes, run npm run docs, this will generate documentation pages and put them in documentation folder.

To view the documentation locally go to http://localhost:8080

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run npm run build to build the project. The build artifacts will be stored in the dist/, this will included a zip file ready for deploying to any DHIS2 instance.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

About

Interactive Dashboard App for DHIS2

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 79.4%
  • HTML 11.3%
  • CSS 9.1%
  • Other 0.2%