Refer to the documentation of Python (2.7), PostgreSQL (9.3 or newer), Redis (2.8.3 or newer) and Node.js (v6 or newer) on how to install them in your environment. On macOS, you can use
brew to install them. On Linux you can use your package manager, although need to make sure it installs recent enough versions.
For development the minimum required packages to install are described in:
You install them with pip:
pip install -r requirements.txt -r requirements_dev.txt
(We recommend installing them in a virtualenv)
Install all packages with:
First time build assets:
npm run build
For development, in most cases the default configuration is enough. But if you need to adjust the database configuration, mail settings or any other setting, you do so with environment variables.
To avoid having to export those variables manually, you can use a
.env file and
bin/run helper script. By invoking any command with
bin/run prefix, it will
load your environment variables from the
.env file and then run your command. For
bin/run ./manage.py check_settings
bin/run ./manage.py database create_tables
The main Redash processes you have to run:
In development you will also run Webpack's dev server or watch utility.
bin/run ./manage.py runserver --debugger --reload
./bin/run celery worker --app=redash.worker --beat -Qscheduled_queries,queries,celery -c2
npm run start
This will result in a Flask web server listening on port
5000, Webpack dev server
8080 and 2 Celery workers ready to run queries.
To open the app in your web browser, use Webpack's dev server --
which will auto reload and refresh whenever you make changes to the frontend code.
Currently we currently have tests only for the backend code. To run them invoke: