Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
Added steps to install and run Superset with Firebolt SQLAlchemy Adapter
  • Loading branch information
apurva-sigmoid authored Sep 28, 2021
1 parent 5d9d581 commit 45c5072
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,40 @@ Interested in contributing? Check out our
to find resources around contributing along with a detailed guide on
how to set up a development environment.

## Installation Steps for Superset+Firebolt SQLAlchemy Adapter

### Pre-requisites

1. Git - https://www.atlassian.com/git/tutorials/install-git
2. Docker - https://docs.docker.com/engine/install/
3. Python3

### Firebolt SQLAlchemy installation steps

````bash
# 1. In your terminal, run below commands to clone superset and switch to firebolt-integration branch
$ cd $HOME
$ git clone https://github.com/raghavSharmaSigmoid/superset.git
$ cd superset
$ git checkout firebolt-integration

# 2. Run below commands to clone firebolt adapter into superset folder
$ cd superset
$ git clone https://github.com/raghavSharmaSigmoid/firebolt-sqlalchemy.git

# 3. Run below commands to build the firebolt adapter
$ cd firebolt-sqlalchemy
$ python3 -m build

# 4. Run below commands to create local requirements text file which has firebolt adapter path
$ cd $HOME/superset
$ touch ./docker/requirements-local.txt
$ echo "firebolt-sqlalchemy@file://localhost/app/superset/firebolt-sqlalchemy/dist/firebolt-sqlalchemy-0.0.1.tar.gz#egg=firebolt-sqlalchemy" >> ./docker/requirements-local.txt

# 5. Run below command to start docker
$ docker-compose up
````

## Resources

- Superset 1.0
Expand Down

0 comments on commit 45c5072

Please sign in to comment.