Developer Machine Setup

Step-by-step instructions to set up RudderStack on your developer machine.

Prerequisites

To set up RudderStack, you will need to set up and install the following tools in your development environment:

Installation

  • First, set up the database in your preferred directory using the following commands:

createdb jobsdb
createuser --superuser rudder
psql "jobsdb" -c "alter user rudder with encrypted password 'rudder'";
psql "jobsdb" -c "grant all privileges on database jobsdb to rudder";
  • Sign up and log into the RudderStack dashboard. Copy your workspace Token from the top of the page, as shown:

Why do I need to sign up on RudderStack?

RudderStack's dashboard (Control Plane) lets you set up your data pipelines by configuring event data sources and destinations. This dashboard is hosted by RudderStack and is free for open-source users.

If you don't wish to sign up for RudderStack, you can also set up your own control plane using the open-source RudderStack Config Generator. However, note that the control plane set up using the RudderStack Config Generator lacks certain features like Transformations and Live Events Debugger.

  • Next, clone the RudderStack server repository. Then, run git submodule init and git submodule update to fetch the rudder-transformer repository.

  • Next, navigate to the Transformer directory using the following command:

cd rudder-transformer
  • Install dependencies using the command npm i . Then, start the destination transformer using the following command:

node destTransformer.js
  • Navigate back to the main directory using the command cd rudder-server. Copy the sample.env to the main directory using the following command:

cp config/sample.env .env
  • Update theWORKSPACE_TOKEN environment variable in this file with the workspace token you copied from the RudderStack dashboard.

  • Finally, run the RudderStack server using the following command:

go run -mod=vendor main.go

Once you have completed these steps above successfully, send test events to verify the installation.

Contact Us

If you come across any issues while setting up RudderStack, feel free to contact us. You can also start a conversation on our Slack channel.