Back to Activepieces

Fork Repository

docs/build-pieces/building-pieces/setup-fork.mdx

0.82.11.1 KB
Original Source

To start building pieces, we need to fork the repository that contains the framework library and the development environment. Later, we will publish these pieces as npm artifacts.

Follow these steps to fork the repository:

<Warning> If you are on windows, please install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and set up git there then proceed with the instructions down below </Warning> 1. Go to the repository page at https://github.com/activepieces/activepieces. 2. Click the `Fork` button located in the top right corner of the page.

  1. Clone your fork using a shallow clone for faster setup:
bash
git clone --depth=1 https://github.com/YOUR_USERNAME/activepieces.git
<Tip> Using `--depth=1` reduces the clone size significantly by only fetching the latest commit instead of the full history. </Tip> <Tip> If you are an enterprise customer and want to use the private pieces feature, you can refer to the tutorial on how to set up a [private fork](../misc/private-fork). </Tip>