bpptkg / display-device

BPPTKG Data Visualization App

Data Visualization

Data Visualization System (Davis) is a full front-end app built using Vue.js, Bootstrap, ECharts, and many awesome open source libraries. It provides various charts and analytics information about BPPTKG monitoring data. See example screenshots here.

For current version, Davis only supports Vue.js version 2, Bootstrap version 4, and ECharts version 4. Currenty, the project only runs on Node.js version 16.x.

Environment Variables Settings

There are several required environment variables that need to be set in .env file:

• VUE_APP_BMA_URL

  BMA web services URL, e.g. https://bma.cendana15.com to fetch various monitoring data. The app will automatically prefix any web request with /api/v1/ because all monitoring data use v1 endpoints. See client module in the src/utils/client.js.

• VUE_APP_BMA_API_KEY

  BMA API key credentials to grant access to the APIs. You can contact BMA administrator to get the key.

• VUE_APP_CENDANA_URL

  Cendana15 web services URL, e.g. https://cendana15.com. This is used to get user account info and grant permissions to access the resources provided by Cendana15 web services.

  On production environment, if user is not authenticated, they will be redirected to the login page. On local development, user authentication may be skipped.

Project Setup

Clone the project from GitHub repository:

git clone https://github.com/bpptkg/display-device.git

Install all package dependencies:

npm install

Compile and hot-reload for development:

npm run serve

Lint and fix files if you made a change to the script:

npm run lint

Deployment

After you've cloned the project, install all package dependencies:

npm ci

Set required environment variables settings in .env file. Then, compile and minify for production:

npm run build

On production environment, we deploy the app using /display-device/ public path. You can change this setting by adding VUE_APP_PUBLIC_PATH in your .env file. You have to also add the following to the Nginx configuration:

location /display-device {
    alias /path/to/display-device/dist/;
    try_files $uri $uri/ /index.html = 404;
}

In order to build the project, DD needs to read Git commit to mark build revision. It may not work if you compile the source code without including Git history, i.e. downloading the source code instead of cloning.

On staging environment, we deploy the app using /display-device-dev/ public path. To build for staging, create .env.staging.local file and add the following:

NODE_ENV=production
VUE_APP_PUBLIC_PATH=/display-device-dev/

Then, run:

npm run build -- --mode staging

Do not forget to adjust your Nginx site location configuration if you deploy for staging.

License

MIT