Developer Machine Setup

Detailed instructions to set up RudderStack on your developer machine

Please follow these steps to set up RudderStack on your developer machine:

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";
  • Go to the RudderStack dashboard and set up your account. Copy your workspace token from the top of the home page.

Why do I need this? RudderStack's dashboard (control plane) is where you can setup sources, destinations, and transformations. RudderStack hosts the control plane and is free for OSS users. You can also use our open-source config-generator if you don't want to use the hosted control plane (the config generator lacks certain features like Transformations and LiveDebugger.)

  • Clone the RudderStack server repository. Run git submodule init and git submodule update to fetch the rudder-transformer repository. Then, navigate to the transformer directory using the following command:

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

node destTransformer.js
  • Navigate back to the main directory using the following 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 with the workspace token fetched from the RudderStack dashboard.

  • Run the backend server using the following command:

go run -mod=vendor main.go

Once you have successfully followed the steps above, follow our guide on How to Send Test Events in order to test if there are any issues with the installation.