### Install Dependencies
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations-ts/README.md
Installs project dependencies using yarn. Ensure Node.js v16.16+ is installed.
```bash
yarn install
```
--------------------------------
### Project Setup and Local Development
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/SETUP.md
Steps to clone the project, install dependencies, and start the development server for the GitHub monday code sample app.
```git
git clone https://github.com/mondaycom/welcome-apps
```
```bash
cd apps/github-monday-code
npm install
npm run dev
```
--------------------------------
### Run Project with Ngrok
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations-ts/README.md
Starts the project server and exposes it via an ngrok tunnel. Requires MONDAY_SIGNING_SECRET in the .env file.
```bash
npm start
```
--------------------------------
### Install Project Dependencies
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/word-cloud/README.md
Installs all the necessary packages required to run the Monday.com Word Cloud app. This is a standard Node.js project setup step.
```bash
npm install
```
--------------------------------
### Install Node Modules
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Installs the necessary Node.js packages for the project. Ensure you have Node.js (v10+) and npm installed.
```bash
$ npm install
```
--------------------------------
### Install Dependencies
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-react/README.md
Installs the necessary project dependencies using npm.
```bash
npm install
```
--------------------------------
### Start Development Server
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-react/README.md
Starts the application locally for development and testing. Provides a public URL for the running application.
```bash
npm start
```
--------------------------------
### Initialize Monday CLI for Deployment
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Initializes the Monday.com command-line interface for deploying your application.
```bash
$ npm run deploy:init
```
--------------------------------
### Run Development Server
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Starts the local development server to test the integration. This command also typically displays your tunnel URL.
```bash
$ npm run dev
```
--------------------------------
### Start the Project
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/onboarding-example/README.md
Starts the development server for the Monday.com Welcome Apps project. The output will provide a URL to be used in the Monday.com board view feature's custom URL field.
```bash
npm run start
```
--------------------------------
### Install Project Dependencies
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-fullstack-react-node/client/README.md
Installs all necessary packages for the project using npm. This is a prerequisite before running the application.
```bash
npm install
```
--------------------------------
### Start Development Server
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/README.md
Starts the application server in development mode, allowing for live updates and debugging.
```bash
npm run dev
```
--------------------------------
### React App Setup
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/onboarding-example/index.html
Instructions for running a React application, highlighting the requirement for JavaScript.
```html
You need to enable JavaScript to run this app.
```
--------------------------------
### Install monday apps CLI
Source: https://github.com/mondaycom/welcome-apps/blob/master/README.md
Installs the monday apps CLI globally on your machine, which is required for local development and tunneling.
```bash
npm i -g @mondaycom/apps-cli
```
--------------------------------
### Deploy to Monday Code
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Deploys your application to the Monday.com code environment after initialization.
```bash
$ npm run deploy
```
--------------------------------
### Install Project Dependencies
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/onboarding-example/README.md
Installs all necessary packages for the Monday.com Welcome Apps project. This command should be run in the project's root directory.
```bash
npm install
```
--------------------------------
### React App Setup
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-react/index.html
Instructions for running a React application, highlighting the requirement for JavaScript.
```html
You need to enable JavaScript to run this app.
```
--------------------------------
### React App Setup
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-workdocs/index.html
Instructions for running a React application, highlighting the requirement for JavaScript.
```html
You need to enable JavaScript to run this app.
```
--------------------------------
### Install Node Modules
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/README.md
Installs all the necessary dependencies for the project using npm.
```bash
npm install
```
--------------------------------
### Clone Integration Subdirectory with Degit
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Use degit to clone only the 'quickstart-integrations' subdirectory from the mondaycom/welcome-apps GitHub repository. This is a convenient way to get the example code without cloning the entire repository.
```bash
npx degit github:mondaycom/welcome-apps/apps/quickstart-integrations
```
--------------------------------
### Install Node Modules and Start Server
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/jira-node/README.md
Commands to install project dependencies using npm and start the local development server. Requires Node.js 18+.
```bash
nvm use
npm install
npm run start
```
--------------------------------
### Run Development Server
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/README.md
Starts the project's development server.
```bash
$ npm run dev
```
--------------------------------
### Install Dependencies
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-fullstack-react-node/README.md
Installs project dependencies using npm. Requires Node.js v18+.
```bash
npm install
```
--------------------------------
### Install Monday Apps CLI Globally
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/README.md
Installs the Monday Apps CLI globally on the system, making its commands accessible from any directory.
```bash
npm i -g @mondaycom/apps-cli
```
--------------------------------
### Promote to Live and Install
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Instructions for promoting the app to live and installing it on a monday.com account. This includes a note about creating new draft versions for subsequent changes.
```javascript
// In monday Developer Center:
// 1. Click 'Promote to Live'
// 2. Go to Distribute > Install
// 3. Click 'Install App'
// Note: For changes after promoting to live, create a new draft version.
```
--------------------------------
### Create a tunnel for local development
Source: https://github.com/mondaycom/welcome-apps/blob/master/README.md
Creates a tunnel for the specified example directory, allowing local development servers to be exposed to the internet for monday.com integration.
```bash
mapps tunnel:create
```
--------------------------------
### Slack OAuth and Permissions Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Details the scopes and redirect URLs required for the Slack application to interact with the Monday.com integration.
```APIDOC
Slack App Configuration:
Scopes:
- chat:write
- channels:read
- channels:join
Redirect URLs:
- https://apps-credentials.monday.com/authorize/oauth2/redirect-uri
```
--------------------------------
### Install and Run Workspace View App
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/workspace-view-app/README.md
Instructions for installing dependencies and running the monday.com workspace view application. Assumes Node.js and npm are installed.
```bash
npm install
nvm use
npm run start
```
--------------------------------
### Run Development Server
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-fullstack-react-node/client/README.md
Starts the monday.com tunnel and runs the application in development mode. Access the app via the provided localhost URL.
```bash
npm run dev
```
--------------------------------
### Monday Code Environment Variables
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Environment variables required for hosting the application on Monday.com code, including the server URL.
```APIDOC
Environment Variables for Monday Code:
LOCAL_SERVER_URL=your_monday_code_url
MONDAY_SIGNING_SECRET=your_signing_secret
```
--------------------------------
### Initialize a new monday app
Source: https://github.com/mondaycom/welcome-apps/blob/master/README.md
Initializes a new monday.com app project using a personal access token. This command sets up the basic project structure.
```bash
mapps init -t
```
--------------------------------
### Build the Monday.com App for Release
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/word-cloud/README.md
Compiles and prepares the Monday.com Word Cloud app for deployment. The output is placed in the './build' directory.
```bash
npm run build
```
--------------------------------
### Monday SDK Usage Examples
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/docs-viewer/README.md
Demonstrates how to interact with the Monday SDK for various functionalities like getting settings, context, making API calls, and using storage.
```javascript
// Example for settings
monday.get('settings');
// Example for context
monday.get('context');
// Example for API query
monday.api('query { me { name } }');
// Example for storage
monday.storage.setItem('myKey', 'myValue');
monday.storage.getItem('myKey');
```
--------------------------------
### Install Project Dependencies
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/docs-viewer/README.md
Installs all the necessary dependencies for the project using npm. This is a prerequisite for running the application.
```bash
npm install
```
--------------------------------
### React Monday App Setup
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-fullstack-react-node/client/public/index.html
Basic setup and requirements for running a React-based Monday.com app. Emphasizes the need for JavaScript enablement.
```html
Monday App
```
--------------------------------
### Monday.com Credentials Feature Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Configuration steps for creating a 'Credentials' feature within Monday.com to manage Slack OAuth credentials.
```APIDOC
Monday.com Credentials Feature:
Feature Type: Integration > Credentials
Parameters:
- Client ID (from Slack)
- Client Secret (from Slack)
- Include in Request header: Yes
OAuth Endpoint Configuration:
- Authorization URL: GET https://slack.com/oauth/v2/authorize
- Scope: channels:join,channels:read,chat:write
- Access Token Request URL: https://slack.com/api/oauth.v2.access
- Refresh Token Request URL: https://slack.com/api/oauth.v2.access
Extra Details:
- Provider Identifier Route: {your-tunnel-url}/credentials/provider-identifier
- Token Expiration Time (seconds): 3600
```
--------------------------------
### Initialize Monday Code
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/README.md
Initializes the Monday code environment for the first-time deployment, prompting for the Monday access token.
```bash
npm run mapps:init
```
--------------------------------
### Run the Monday.com App
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/word-cloud/README.md
Starts the Monday.com Word Cloud app with an automatic ngrok tunnel for public access. This command is used for local development and testing.
```bash
npm start
```
--------------------------------
### Deploy Application
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-react/README.md
Deploys the application to Monday.com. This command will prompt the user to select the app and version for connection.
```bash
npm run deploy
```
--------------------------------
### Add MONDAY_SIGNING_SECRET
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
This snippet shows how to add the MONDAY_SIGNING_SECRET to your application's secrets. This is a crucial step for authenticating with the monday.com platform.
```bash
MONDAY_SIGNING_SECRET=your_monday_signing_secret
```
--------------------------------
### Monday.com Workflow Integration Feature Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Configuration for an 'Integration for monday workflows' feature in Monday.com to execute actions, such as posting to Slack.
```APIDOC
Monday.com Workflow Integration Feature:
Feature Type: Integration > Integration for monday workflows
Block Type: Action
Credentials:
- Select the credential field created in Step 1.
Input Fields:
- Board (key: boardId)
- GetChannels (key: channel)
- Item (key: itemId)
- Column (key: columnId)
Output Fields:
- (Empty for now)
API Configuration:
- Execution URL: {your-tunnel-url}/monday/execute_action
```
--------------------------------
### Install Node Modules
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/README.md
Installs the necessary Node.js dependencies for the project.
```bash
$ npm install
```
--------------------------------
### Install App Dependencies
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Installs all the necessary Node.js packages required for the integration app to run. This command reads the 'package.json' file and downloads the dependencies into the 'node_modules' directory.
```bash
npm install
```
--------------------------------
### Deploy to Monday Code Hosting
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-fullstack-react-node/README.md
Deploys the application to monday code hosting using the monday apps CLI. This command initiates the deployment process, allowing you to choose the app and draft version.
```bash
npm run deploy
```
--------------------------------
### Local Development Setup
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Steps to set up a local development environment for a monday.com app. This involves adding a signing secret, running the app server, and obtaining a tunnel URL.
```bash
npm run dev
```
--------------------------------
### Monday.com Custom Field Feature Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/SETUP.md
Configuration for a 'custom field for monday workflows' feature in Monday.com to select Slack channels.
```APIDOC
Monday.com Custom Field Feature:
Feature Type: Integration > custom field for monday workflows
Field Details:
- Name: GetChannels
- Field Schema: String
Configuration:
- Remote Options URL: {your-tunnel-url}/monday/get_remote_list_options
- Placeholder for empty list: (User-defined)
Credentials:
- Select the credential field created in Step 1.
```
--------------------------------
### Run Development Server
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-fullstack-react-node/README.md
Builds the client code and runs the server with an ngrok tunnel for local development. Requires MONDAY_SIGNING_SECRET to be set in the .env file.
```bash
npm run dev-server
```
--------------------------------
### Deploy App to Monday Code
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/README.md
Deploys the application to Monday Code, requiring selection of the app and draft version.
```bash
npm run deploy
```
--------------------------------
### Environment Variables Setup
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/SETUP.md
Guidance on adding monday.com and GitHub OAuth credentials (client ID, client secret, tunnel URL) to the .env file.
```env
PORT=8080
```
--------------------------------
### Deploy App to monday Servers
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Deploys the integration app to monday.com servers. This command will prompt for your API token and the app/version to deploy to. Ensure you have completed the setup in the monday Developer Center before running this.
```bash
npm run deploy
```
--------------------------------
### Enable JavaScript Requirement
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-workdocs/public/index.html
This snippet indicates a fundamental requirement for running the Workdocs Quickstart application. Users must have JavaScript enabled in their browser to interact with and utilize the app's features.
```text
You need to enable JavaScript to run this app.
```
--------------------------------
### Run the Application
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/docs-viewer/README.md
Starts the application with an automatic virtual tunnel. The tunnel URL provided is essential for configuring the Monday.com app.
```bash
npm start
```
--------------------------------
### View Server Logs
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/README.md
Retrieves server logs from the Monday logger, useful for debugging deployed applications.
```bash
npm run logs
```
--------------------------------
### Monday App Feature Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/word-cloud/README.md
Details the steps to configure a Monday.com app's features, specifically setting up a 'Boards View' and linking it to a custom ngrok URL.
```APIDOC
Create new 'Word Cloud Example App'
OAuth & Permissions:
Add scope: boards:read
Features:
Create new 'Boards View' feature
View Setup:
Custom URL:
```
--------------------------------
### Use Specific Node.js Version
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/README.md
Switches the current Node.js environment to the version specified in the project's .nvmrc file.
```bash
nvm use
```
--------------------------------
### Monday App View Settings Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/word-cloud/README.md
Demonstrates how to add custom settings fields to a Monday.com app's view. This includes fields for 'Max number of words' and 'Padding', which influence the word cloud's appearance.
```APIDOC
Add Fields:
Type: Column
Settings: Default
Type: Buttons
Title: Max number of words
Name: maxWords
Options: 50, 100, 150, 200, 300
Type: Buttons
Title: Padding
Name: padding
Options:
Small | 10
Medium | 20
Large | 30
```
--------------------------------
### Deploying App to monday code hosting
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/SETUP.md
Commands to initialize the app, push the code, and manage environment variables using the monday CLI.
```bash
mapps init
mapps code:push
mapps code:secret
```
--------------------------------
### Build the Project for Release
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/docs-viewer/README.md
Builds the project for deployment. The output is typically placed in a './build' folder, which is then zipped for upload.
```bash
npm run build
```
--------------------------------
### Robotstxt Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/onboarding-example/public/robots.txt
This snippet shows the robotstxt.org configuration for the welcome-apps project. It specifies that all user agents are allowed to crawl the site without any disallowed paths.
```robotstxt
User-agent: *
Disallow:
```
--------------------------------
### Robotstxt Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-fullstack-react-node/client/public/robots.txt
This snippet shows the robotstxt.org configuration for the welcome-apps project. It specifies that all user agents are allowed to crawl the site without any disallowed paths.
```robotstxt
User-agent: *
Disallow:
```
--------------------------------
### Robotstxt Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-react/public/robots.txt
This snippet shows the robotstxt.org configuration for the welcome-apps project. It specifies that all user agents are allowed to crawl the site without any disallowed paths.
```robotstxt
User-agent: *
Disallow:
```
--------------------------------
### Monday.com OAuth Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/SETUP.md
Instructions for configuring OAuth in monday.com by adding a redirect URL.
```env
https:///auth/monday/callback
```
--------------------------------
### Use Node Version
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/slack-node/README.md
Ensures the correct Node.js version is used for the project.
```bash
$ nvm use
```
--------------------------------
### Robotstxt Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-workdocs/public/robots.txt
This snippet shows the robotstxt.org configuration for the welcome-apps project. It specifies that all user agents are allowed to crawl the site without any disallowed paths.
```robotstxt
User-agent: *
Disallow:
```
--------------------------------
### Robotstxt Configuration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/workspace-view-app/public/robots.txt
This snippet shows the robotstxt.org configuration for the welcome-apps project. It specifies that all user agents are allowed to crawl the site without any disallowed paths.
```robotstxt
User-agent: *
Disallow:
```
--------------------------------
### GitHub OAuth App Registration
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/github-monday-code/SETUP.md
Details for registering a new OAuth app on GitHub, including Homepage URL and Authorization Callback URL.
```env
Homepage URL:
Authorization Callback URL: https:///auth/github/callback
```
--------------------------------
### monday.com Integration Action Endpoint
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
This describes how monday.com interacts with your deployed integration app. When a trigger event occurs on a board (e.g., a text column changes), monday.com sends a POST request to your app's '/monday/execute_action' endpoint. The logic for handling these events is defined within your app's source code, typically in a file like 'src/index.js'.
```APIDOC
Endpoint:
POST /monday/execute_action
Description:
This endpoint is called by monday.com when a configured integration trigger event occurs on a board.
Request Body:
(Structure depends on the specific integration trigger and configuration)
Response:
(Structure depends on the integration's logic and expected output)
How it works:
When a trigger event occurs (e.g., a specific text column changing), monday.com sends a POST request to your app's '/monday/execute_action' endpoint. The function handling this request is defined in your app's backend code (e.g., src/index.js).
```
--------------------------------
### Create Integration Feature
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Configuration details for creating an 'Integration for monday workflows' feature. This includes specifying the block name, type, execution URL, and defining input fields.
```APIDOC
Feature Type: Integration for monday workflows
Block Name: Change text case
Block Type: Action
Execution URL: [YOUR VERSION URL]/monday/execute_action
Fields:
- Field Type: Board, Field Key/Title: boardId
- Field Type: Item, Field Key/Title: itemId
- Field Type: Text column, Field Key/Title: sourceColumnId
- Field Type: Text column, Field Key/Title: targetColumnId
```
--------------------------------
### Set Monday Signing Secret Environment Variable
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Sets the 'MONDAY_SIGNING_SECRET' environment variable for your monday.com app using the mapps CLI. This secret is crucial for authentication between your app and the monday.com platform. You need to replace '' with your actual signing secret and '' with your app's unique identifier.
```bash
mapps code:env -m set -k MONDAY_SIGNING_SECRET -v -i
```
--------------------------------
### Create Custom Field Feature
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Configuration details for creating a 'Custom field for monday workflows' feature. This involves defining the field name, key, schema type, and remote options URL.
```APIDOC
Feature Type: Custom field for monday workflows
Field Name: Transformation type
Default Field Key: transformationType
Schema Type: String
Configuration:
Add remote options:
Remote options URL: [YOUR SERVER URL]/monday/get_remote_list_options
```
--------------------------------
### Add Custom Field to Integration Feature
Source: https://github.com/mondaycom/welcome-apps/blob/master/apps/quickstart-integrations/README.md
Steps to add the created custom field ('Transformation type') as an input field to the integration feature.
```APIDOC
Navigate to Build > Features and select the Integration feature.
Add a new input field.
Field Type: Transformation type
Field Key: transformationType
Field Title: Transformation type
```
=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.