Your First App

Building your first Workrock app is easy. We provide a CLI to handle the boilerplate and authentication.

Prerequisites

• Node.js (v18 or higher)
• A registered Partner account on the Marketplace.

1. Install the CLI

Install our command-line tool globally:

npm install -g @workrock/cli

2. Authenticate

Link your machine to your developer account:

workrock login

This will open your browser to authenticate.

3. Create a Project

We recommend starting with a Next.js application:

workrock create
cd my-workrock-app

4. Link to Marketplace

Connect your local folder to an app ID registered in the Marketplace:

workrock link

Follow the prompts to select your application. This creates a workrock.json file.

5. Configure Development Environment

To run your app locally and access the Workrock Core API, you need a Sandbox and a Development Token.

Create a Sandbox

This creates an isolated environment seeded with mock data (Projects, Leads, Tasks):

workrock sandbox --create "My Dev Store"

Set up Environment Variables

1. Get your Auth Token: Run this CLI command to see your token:

   cat ~/.workrock/config.json

2. Update workrock-config.ts: Update the workrock-config.ts file in your project (src/config/workrock-config.ts) with your API URL and Development Token (obtained from Marketplace Dashboard):

   export const workrockConfig = {
       apiURL: "WORKROCK_API_URL_HERE",
       devToken: "WORKROCK_DEV_TOKEN_HERE",
   }

6. Run the App

Start the development server with the Workrock CLI wrapper:

workrock dev

You can now open http://localhost:3000 to verify your app is running and fetching data from the API!

Note: When you are ready to test within the Workrock OS iframe, the CLI automatically tunnels your localhost to the platform.