Developer Installation Guide

Installing Dependencies

PostgreSQL & Redis

Refer to the documentation of Python (3), PostgreSQL (9.6 or newer), Redis (3 or newer), Node.js (14.16.1 or newer) on how to install them in your environment. On MacOS, you can use Homebrew to install them. On Linux you can use your package manager, although you need to make sure it installs recent enough versions.

Python Packages

For development the minimum required packages to install are described in:

• requirements.txt
• requirements_dev.txt

You install them with pip:

pip install -r requirements.txt -r requirements_dev.txt

(We recommend installing them in a virtual environment. For certain data source types you need to install additional dependencies from requirements_all_ds.txt.)

Node.js Packages

Install Yarn (1.22.10 or newer):

npm install --global yarn@1.22.10

Install all packages with:

yarn --frozen-lockfile

First time build assets:

yarn build

Configuration

In most cases the default configuration is enough for development. But if you need to adjust the database configuration, mail, or other settings you do so with environment variables.

Creating Database Tables

./manage.py database create_tables

Processes

The main Redash processes you have to run:

• Web server
• RQ worker(s) & scheduler

In development you will also run Webpack’s dev server or watch utility.

Our recommendation:

• Web server: ./manage.py runserver --debugger --reload
• RQ: ./manage.py rq worker
• RQ Scheduler: ./manage.py rq scheduler
• Frontend watch process to rebuild changes: yarn watch

This will result in a Flask web server listening on port 5000, Webpack rebuilding changes to the frontend, RQ worker ready to run queries and RQ scheduler to enqueue periodic tasks.

Health Check for Installation

RESPONSE

PONG.

Running Tests

Backend tests:

pytest tests/

Frontend tests using Cypress:

TBD.