Development setup - Activepieces

Prerequisites

Node.js v18+
npm v9+

Instructions

Setup the environment

bash

node tools/setup-dev.js

Start the environment

This command will start activepieces with sqlite3 and in memory queue.

bash

npm start

<Note> By default, the development setup only builds specific pieces.Open the file `.env.dev` and add comma-separated list of pieces to make available.

For more details, check out the Piece Development section.

</Note>

Go to localhost:4200 on your web browser and sign in with these details:

Email: [email protected] Password: 12345678

Pieces Development

When AP_PIECES_SYNC_MODE is set to OFFICIAL_AUTO, all pieces are automatically loaded from the cloud API and synced to the database on first launch. This process may take a few seconds to several minutes depending on your internet connection.

For local development, pieces are loaded from your local dist folder instead of the database. To enable this, set the AP_DEV_PIECES environment variable with a comma-separated list of pieces. For example, to develop with google-sheets and cal-com:

AP_DEV_PIECES=google-sheets,cal-com npm start