Quickstart guide

This quickstart guide will take you step by step through building a workspace view app. By the end, you'll have a fully functioning app that displays all of the contents of your workspace. Let's get started!

Build your app in monday.com

Our first steps will happen in the monday.com platform, so start by signing into your account. If you don't have one, you can sign up for one here!

  1. Click on your profile picture in the top right corner.
  2. Select Developers. This will open the Developer Center in a new tab.
  3. On the new tab, click Create app.
  4. Change the name of your app and hit Save.

Run your local environment

After building your app on monday, download the example code and run the app locally.

Download the example code

You can download our example apps using git cloneand navigate to the apps/workspace-view-app directory.

git clone https://github.com/mondaycom/welcome-apps
cd apps/workspace-view-app
npm install
npm run start

Run the app locally

Once you set up the example code, it's time to run your app.

  1. In your terminal, navigate to the code you downloaded: cd apps/workspace-view-app.
  2. Install the dependencies using npm:npm install.
  3. Start your development server, which will print the URL of your app: npm run start.
  4. Copy your app URL.

Create a workspace view app feature

After running your app locally and copying the URL, create a new workspace view app feature.

  1. Open your app in monday.
  2. Navigate to the Features tab and select Create feature.
  3. Type Workspace in the search bar on the pop-up.
  4. Click on the Workspace view app feature and then Create.
  5. Rename the feature and paste your app URL (from the previous section).
  6. Click Save.

Test your app

Once you've created your app and connected your local environment to monday, you can test your app in a live workspace.

  1. Open your monday.com account.
  2. Click on the left side menu's Workspace apps section.
  3. Select the app feature you just created, and it will display all of the contents of your workspace!

πŸ“˜

Join our developer community!

We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! 😎