Developer Machine Setup
Step by step guide on setting up the RudderStack data plane (backend) on your developer machine.
Last updated
Was this helpful?
Step by step guide on setting up the RudderStack data plane (backend) on your developer machine.
Last updated
Was this helpful?
This guide lists the steps required to set up the RudderStack data plane (backend) in your development environment.
To set up RudderStack, you will need to set up and install the following tools:
Go 1.17 or above.
Node.js 14.17 or above.
PostgreSQL 11 or above
If you're using a RudderStack-hosted control plane, follow these steps to set up the data plane in your development environment:
Log into your RudderStack Open Source dashboard.
Note and copy your workspace token from the top of the page, as shown:
The workspace token is required for setting up the data plane.
Then, set up the database in your preferred directory using the following commands:
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 rudder-transformer
directory using the following command:
Install the dependencies using the command npm i
. Then, start the destination transformer using the following command:
Navigate back to the main directory using the command cd rudder-server
.
Copy sample.env
to the main directory using the following command:
Update the WORKSPACE_TOKEN
environment variable in this file with the workspace token you copied in Step 2.
Finally, run the RudderStack server using the following command:
If you have self-hosted the control plane using the open-source Control Plane Lite utility, follow the Developer Machine Setup instructions to set up the RudderStack data plane in your development environment.
Once you have successfully performed the steps above, follow the Sending Test Events guide to verify the installation.
If you come across any issues while setting up RudderStack in your development environment, you can contact us or start a conversation in our Slack community.