Skip to main content
Version: 2.22.0

Mac OS


The following guide is intended for contributors to set-up ToolJet locally. If you're interested in self-hosting ToolJet, please refer to the Setup section.

Follow these steps to setup and run ToolJet on macOS for development purposes. Open terminal and run the commands below. We recommend reading our guide on architecture of ToolJet before proceeding.

Setting up

  1. Set up the environment

    1.1 Install Homebrew

    /bin/bash -c "$(curl -fsSL"

    1.2 Install Node.js ( version: v18.3.0 ) and npm (version: v8.11.0)

    brew install nvm
    export NVM_DIR=~/.nvm
    source $(brew --prefix nvm)/
    nvm install 18.3.0
    nvm use 18.3.0
    npm install -g [email protected]

    1.3 Install Postgres


    ToolJet uses a postgres database as the persistent storage for storing data related to users and apps. We do not plan to support other databases such as MySQL.

    brew install postgresql

    1.4 Install PostgREST(optional)


    Required only if Tooljet Database is being used.

    Please use PostgREST version 10.1.1.x

    brew install postgrest --version

    1.5 Clone the repository

    git clone
  2. Set up environment variables

    Create a .env file by copying .env.example. More information on the variables that can be set is given in the environment variables reference

    cp .env.example .env
  3. Populate the keys in the env file


    SECRET_KEY_BASE requires a 64 byte key. (If you have openssl installed, run openssl rand -hex 64 to create a 64 byte secure random key)

    LOCKBOX_MASTER_KEY requires a 32 byte key. (Run openssl rand -hex 32 to create a 32 byte secure random key)


    cat .env
  4. Install and build dependencies

    npm install
    npm install --prefix server
    npm install --prefix frontend
    npm run build:plugins
  5. Set up database

    npm run --prefix server db:create
    npm run --prefix server db:reset

    If at any point you need to reset the database, use this command npm run --prefix server db:reset

  6. Run plugins compilation in watch mode

    cd ./plugins && npm start
  7. Run the server

    cd ./server && npm run start:dev
  8. Run the client

    cd ./frontend && npm start

    The client will start on the port 8082, you can access the client by visiting: http://localhost:8082

  9. Create login credentials

    Visiting https://localhost:8082 should redirect you to the login page, click on the signup link and enter your email. The emails sent by the server in development environment are captured and are opened in your default browser. Click the invitation link in the email preview to setup the account.

Running tests

Test config requires the presence of .env.test file at the root of the project.

To run the unit tests

npm run --prefix server test

To run e2e tests

npm run --prefix server test:e2e

To run a specific unit test

npm run --prefix server test <path-to-file>