README.md

LLM Assistant Plugin for Redash - Visualize Data with Natural Language

---

Set up Prerequisites

Install Required Packages

$ sudo apt -y install docker.io docker-buildx docker-compose-v2 build-essential curl pwgen python3-venv xvfb

Add User to Docker Group

$ sudo usermod -aG docker $USER

Install Node Version Manager (NVM)

$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

Log out and log back in for changes to take effect.

Install NodeJS version 16 using NVM

$ nvm install --lts 16
$ nvm alias default 16
$ nvm use 16

Confirm NodeJS version:

$ nvm list

Install Yarn 1.x

$ npm install --global [email protected]

Clone Redash Source Code and Install Dependencies

$ git clone https://github.com/birehan/Redash-NLP-Chatbot-Analytics
$ cd redash
$ yarn

Generate Environment Variables

Generate the .env file containing required environment variables:

$ make env

Add your OpenAI API key to the .env file:

OPENAI_API_KEY=*****************************************

Compile and Build

Build Redash Frontend

$ make build

Build Local Redash Docker Image

$ make compose_build

Start Redash Locally

Create Database

$ make create_database

Start Docker Containers

$ make up

Access Redash web interface at http://localhost:5001.

Screenshots

Creating a query

Visualizing

Shut Down Containers

$ make down

---

Open for collaborations