Steps to Setup CLIxDashboard - Pardhu448/CLIxDashboard GitHub Wiki

In this part of wiki, we will give detailed steps involved in setting up CLIxDashboard on a server or on a local machine.

Get Source Code
  1. create a folder for CLIxDashboard - 'mkdir CLIxDashboard' and move into it
  2. 'git clone' following repos - CLIxDashboard, clix_dashboard_backend, clix_dashboard_ui
Update machine specific variables
  1. check which ports are available for postgres using this command - sudo lsof -i -P -n | grep LISTEN
  2. Following are usual ports used for potgresql - 5432, 5433, 5434. Use whichever is available at two places:
    • in docker-compose.yml file of CLIxDashboard
    • in config.py file of clix_dashboard_backend
  3. Now update local machine/server ip address in docker-compose.yml file of CLIxDashboard
  4. Update POSTGRES_DB, POSTGRES_USER, POSTGRES_PASSWORD in docker-compose.yml file of CLIxDashboard
  5. Get uid of user in host machine where the above mentioned folders are present. Then update 'DOCKER_UID' in with this uid in docker-compose.yml file of CLIxDashboard
Setup clix_dashboard_backend
  1. Follow the steps described here to setup CLIxDashboard backend
orchestrate constituent containers
  1. run 'docker-compose up -d' command in the CLIxDashboard directory
Initialize Batchprocessing data pipeline using Airflow
  1. Follow steps outlined here
Create Login for schools

  1. After one iteration of processing is done through Airflow, we will have data tables of all schools on backend DB. Follow these steps to create login credentials for these schools

  2. Open CLIxDashboard website at port 3000