Skip to content

React Dashboard made with Material UI’s components. Our pro template contains features like TypeScript version, authentication system with Firebase and Auth0 plus many other

License

Notifications You must be signed in to change notification settings

NHSRC/gunak-dashboard-2

 
 

Repository files navigation

Gunak Dashboard We App

About Gunak Dashboard Web App

  • Gunak dashboard is React JS application. It provides the reporting functionality by embedding metabase dashboards.
  • Metabase is open source software (https://www.metabase.com/) for reporting. Metabase stores the user and report/dashboard definition in its own database. We are using h2 database and version 0.38.2 of metabase.

There are two ways in which one can run Gunak Dashboard application on local environment.

  1. Production metabase - to do this you require SECRET KEY.
  2. Local metabase - you can set up metabase server locally.

Setup development environment

  1. You need node version 14.16.*
  2. Ensure that Make utility is available.
  3. Run make deps to install all JavaScript package dependencies.
  4. Run make test to run unit tests.
  5. If you run dashboard with command make start it will launch the dashboard application connected to local application server. But you will not be able to run any reports since it connects to reporting server which runs in production. For more see the next point.
  6. Run make start-with-prod-server to connect to local application server. When the report is run it would connect to production reporting server.

Using production metabase instance

  1. You would require a secret key and set its value in your environment variable FA_METABASE_SECRET_KEY on the machine which is running Gunak server.
  2. Start the server by executing command make run_server_nhsrc_prod_metabase.
  3. Launch your dashboard application by running command make start-with-prod-server

Using local metabase instance

  1. Install metabase locally by following instructions here (https://www.metabase.com/docs/latest/operations-guide/running-the-metabase-jar-file.html).
  2. Replace the h2 database file by name metabase.db.mv.db (in the same folder as metabase.jar) from the production metabase dump (keep the same name).
  3. Start metabase server by using java -jar metabase.jar
  4. Login to metabase application by connecting to http://localhost:300 and login provided to you.
  5. Go to http://localhost:/admin/settings/embedding_in_other_applications and create/copy the key.
  6. Set the key in OS environment variable of gunak server FA_METABASE_SECRET_KEY
  7. Start the gunak server by executing command make run_server_nhsrc
  8. Launch your dashboard application by running command make start

About

React Dashboard made with Material UI’s components. Our pro template contains features like TypeScript version, authentication system with Firebase and Auth0 plus many other

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.8%
  • HTML 1.5%
  • Makefile 0.7%