### Install Example App

Source: https://github.com/contentful/apps/blob/master/examples/function-appaction/INSTRUCTIONS.md

Use this command to install the example app. Navigate to the created directory afterwards.

```bash
npx create-contentful-app@latest --example function-appaction
```

```bash
cd <name-of-your-app>
```

```bash
npm i
```

--------------------------------

### Install the example app

Source: https://github.com/contentful/apps/blob/master/examples/app-parameters/README.md

Use this command to initialize the example project via the Contentful CLI.

```bash
npx create-contentful-app@latest --example app-parameters
```

--------------------------------

### Install Example App

Source: https://github.com/contentful/apps/blob/master/examples/function-comment-bot/INSTRUCTIONS.md

Use this command to install the function-comment-bot example.

```shell
npx create-contentful-app@latest --example function-comment-bot
```

--------------------------------

### Install Dependencies and Run Setup

Source: https://github.com/contentful/apps/blob/master/examples/default-values-backend/README.md

Install project dependencies and execute the setup script to register the app in Contentful.

```shell
yarn
yarn setup
# or
npm install
npm run setup
```

--------------------------------

### Install Example App

Source: https://github.com/contentful/apps/blob/master/examples/function-appevent-filter/INSTRUCTIONS.md

Use the Contentful CLI to scaffold a new project with the event filter function example.

```bash
npx create-contentful-app@latest --example function-appevent-filter
```

--------------------------------

### Local Development Setup: Frontend

Source: https://github.com/contentful/apps/blob/master/apps/google-analytics-4/VALIDATION.md

Navigate to the frontend directory and start the development server.

```bash
cd /Users/zachary.yankiver/Documents/Marketplace\ Apps/apps/apps/google-analytics-4/frontend
HOST=localhost npm start
```

--------------------------------

### Initial Project Setup

Source: https://github.com/contentful/apps/blob/master/CONTRIBUTING.md

Clone the repository, install root dependencies, and bootstrap the project. Use 'SINCE=master' to ensure all necessary packages are linked.

```bash
git clone https://github.com/contentful/apps.git
cd apps
npm ci
SINCE=master npm run bootstrap
```

--------------------------------

### Start the Backend Application

Source: https://github.com/contentful/apps/blob/master/examples/default-values-backend/README.md

Launch the backend server after completing the setup process.

```shell
yarn start
```

--------------------------------

### Install and Initialize Contentful App

Source: https://github.com/contentful/apps/blob/master/apps/bedrock-content-generator/README.md

Run these commands to install dependencies, create an app definition, and start the development server.

```bash
npm i \
npm run create-app-definition \
npm start
```

--------------------------------

### Local Development Setup: Backend

Source: https://github.com/contentful/apps/blob/master/apps/google-analytics-4/VALIDATION.md

Navigate to the lambda directory and start the backend services using Docker Compose.

```bash
cd /Users/zachary.yankiver/Documents/Marketplace\ Apps/apps/apps/google-analytics-4/lambda
docker compose up --build
```

--------------------------------

### Run Interactive Setup Script

Source: https://github.com/contentful/apps/blob/master/apps/jira/README.md

Use this script for first-time setup or after a long break. It checks dependencies, configures the .env file, displays the Atlassian checklist, and can start the development server.

```bash
cd apps/jira
npm run setup
```

--------------------------------

### Bootstrap Contentful App with Example

Source: https://github.com/contentful/apps/blob/master/examples/blog-post-metrics/README.md

Use these commands to bootstrap a new Contentful app with a specific example. Ensure you have npm, npx, or yarn installed.

```bash
npx create-contentful-app --example blog-post-metrics
```

```bash
npm init contentful-app -- --example blog-post-metrics
```

```bash
yarn create contentful-app --example blog-post-metrics
```

--------------------------------

### Bootstrap Example with Different Package Managers

Source: https://github.com/contentful/apps/blob/master/apps/bedrock-content-generator/README.md

Use these commands to bootstrap an example Contentful app using npm, npx, or yarn.

```bash
# npx
npx create-contentful-app --example vite-react
```

```bash
# npm
npm init contentful-app --example vite-react
```

```bash
# Yarn
yarn create contentful-app --example vite-react
```

--------------------------------

### Run the setup script

Source: https://github.com/contentful/apps/blob/master/examples/app-parameters/README.md

Execute the automated setup script to configure the app definition and content types.

```bash
npm run setup
```

--------------------------------

### Install and Run Contentful App

Source: https://github.com/contentful/apps/blob/master/examples/page-location/README.md

After bootstrapping the app, install its dependencies and start the development server using npm or yarn. The app will be available at http://localhost:3000.

```bash
npm install
npm start
```

```bash
yarn
yarn start
```

--------------------------------

### Bootstrap Contentful App with Remix Example

Source: https://github.com/contentful/apps/blob/master/examples/remix/README.md

Use this command to bootstrap a new Contentful App project with the Remix framework example. Ensure you have Node.js installed.

```bash
npx create-contentful-app --example remix
```

```bash
npm init contentful-app -- --example remix
```

```bash
yarn create contentful-app --example remix
```

--------------------------------

### setup

Source: https://github.com/contentful/apps/blob/master/packages/dam-app-base/docs/README.md

Initializes the app integration.

```APIDOC
## setup

### Description
Initializes the provided integration.

### Parameters
- **integration** (Integration) - Required - The integration object to set up.

### Returns
- **void**
```

--------------------------------

### Run Frontend Development Server

Source: https://github.com/contentful/apps/blob/master/apps/smartling/README.md

Installs dependencies and starts the local development server for the React frontend.

```bash
npm install
npm run start
```

--------------------------------

### Bootstrap Contentful App Example

Source: https://github.com/contentful/apps/blob/master/examples/home-location/README.md

Use these commands to bootstrap the home-location example for a Contentful app.

```bash
npx create-contentful-app --example home-location
```

```bash
npm init contentful-app -- --example home-location
```

```bash
yarn create contentful-app --example home-location
```

--------------------------------

### Bootstrap Contentful App with Page Location Example

Source: https://github.com/contentful/apps/blob/master/examples/page-location/README.md

Use these commands to create a new Contentful app with the page-location example. Ensure you have Node.js and npm/npx/yarn installed.

```bash
npx create-contentful-app --example page-location
```

```bash
npm init contentful-app -- --example page-location
```

```bash
yarn create contentful-app --example page-location
```

--------------------------------

### Bootstrap Contentful App with Example

Source: https://github.com/contentful/apps/blob/master/examples/editor-assignment/README.md

Use these commands to bootstrap a Contentful app with the editor-assignment example. Choose the command that matches your package manager.

```bash
npx create-contentful-app --example editor-assignment
```

```bash
npm init contentful-app -- --example editor-assignment
```

```bash
yarn create contentful-app --example editor-assignment
```

--------------------------------

### Install dependencies

Source: https://github.com/contentful/apps/blob/master/apps/auto-prefix/README.md

Run this command to install the necessary project dependencies.

```bash
npm install
```

--------------------------------

### Clone and Install Dependencies

Source: https://github.com/contentful/apps/blob/master/apps/klaviyo/README.md

Initializes the project repository and installs required Node.js packages.

```bash
git clone https://github.com/contentful/marketplace-partner-apps.git
cd marketplace-partner-apps/apps/klaviyo
```

```bash
npm install
```

--------------------------------

### Bootstrap Contentful App with Example

Source: https://github.com/contentful/apps/blob/master/examples/function-potterdb/README.md

Use this command to create a new Contentful app project with the PotterDB example pre-configured.

```bash
npx create-contentful-app@latest --example function-potterdb
```

--------------------------------

### View migration guide

Source: https://github.com/contentful/apps/blob/master/apps-migration-scripts/README.md

Displays the comprehensive migration tutorial.

```bash
cat GETTING_STARTED.md
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/contentful/apps/blob/master/apps/jira/README.md

Install dependencies for the main app and the functions directory. This is a required step for setting up the project.

```bash
cd apps/jira
npm install
cd functions && npm install && cd ..
```

--------------------------------

### Bootstrap a Contentful App with Examples

Source: https://github.com/contentful/apps/blob/master/examples/last-fm/README.md

Use these commands to create a new Contentful app, optionally with a specific example. Available for npm, npx, and Yarn.

```bash
npx create-contentful-app --example last-fm
```

```bash
npm init contentful-app -- --example last-fm
```

```bash
yarn create contentful-app --example last-fm
```

--------------------------------

### Run interactive migration tutorial

Source: https://github.com/contentful/apps/blob/master/apps-migration-scripts/README.md

Starts an interactive session for app selection and safety checks.

```bash
./getting-started.sh
```

--------------------------------

### setup Function

Source: https://github.com/contentful/apps/blob/master/packages/ecommerce-app-base/docs/README.md

Sets up the integration with a generic product type.

```APIDOC
## setup

▸ **setup**<`P`
>(`integration`): `void`

#### Type parameters

| Name | Type |
| :------ | :------ |
| `P` | extends [`Product`](README.md#product) = [`Product`](README.md#product) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `integration` | [`Integration`](README.md#integration)<`P`
>

#### Returns

`void`
```

--------------------------------

### App Installation and Configuration

Source: https://github.com/contentful/apps/blob/master/examples/native-external-references-tmdb/README.md

Instructions on how to install a Contentful app and configure it with necessary API tokens.

```APIDOC
## Installing the App

### Description
Instructions for installing a Contentful app after uploading it. This involves selecting a space and environment, granting access, and configuring the app with necessary tokens.

### Method
Command Line Interface (CLI)

### Endpoint
N/A (CLI command)

### Parameters
N/A

### Request Example
```bash
npm run install-app
```

### Response
- Configuration screen rendered by `<ConfigScreen />` component.
- User is prompted to input TMDB API token.
- App is configured and installed upon saving changes.
```

--------------------------------

### Start development server

Source: https://github.com/contentful/apps/blob/master/apps/auto-prefix/README.md

Starts the app in development mode with automatic reloading.

```bash
npm run start
```

--------------------------------

### Install Dependencies

Source: https://github.com/contentful/apps/blob/master/apps/drive-integration/README.md

Install the necessary Node.js dependencies for the app.

```bash
npm install
```

--------------------------------

### Bootstrap Contentful App with Example

Source: https://github.com/contentful/apps/blob/master/examples/function-potterdb-rest-api/README.md

Use this command to bootstrap a new Contentful App with the PotterDB REST API example. This sets up the project structure and dependencies.

```bash
npx create-contentful-app --example function-potterdb-rest-api
```

--------------------------------

### Bootstrap the Contentful App

Source: https://github.com/contentful/apps/blob/master/examples/native-external-references-tmdb/README.md

Initialize a new project using the native-external-references example template.

```bash
npx create-contentful-app@latest <name-of-your-app> --example native-external-references
```

--------------------------------

### Bootstrap the Autotagger Example

Source: https://github.com/contentful/apps/blob/master/examples/autotagger/README.md

Commands to initialize the project using the create-contentful-app CLI.

```bash
# npx
npx create-contentful-app --example autotagger

# npm
npm init contentful-app -- --example autotagger

# Yarn
yarn create contentful-app --example autotagger
```

--------------------------------

### Setup Contentful Ecommerce App Base

Source: https://github.com/contentful/apps/blob/master/packages/ecommerce-app-base/README.md

Use the `setup` function to initialize the ecommerce-app-base library. Configure callbacks for UI elements, app metadata, parameter validation, product fetching, dialog rendering, and more. Ensure all required parameters are defined.

```javascript
import { setup } from '@contentful/ecommerce-app-base';

setup({
  makeCTA: () => 'Select products',
  name: 'My SKU App',
  logo: 'https://example.com/logo.svg',
  color: '#d7f0fa',
  description: 'My example SKU App',
  parameterDefinitions: [
    {
      "id": "category",
      "type": "Symbol",
      "name": "Catehory",
      "description": "Product category of our shop",
      "required": true
    }
  ],
  validateParameters: () => null,
  fetchProductPreviews: async (skus) => {
      const responess = await Promise.all(
          skus.map(sku => fetch(`https://example.com/products/${sku}`))
      );
      return responses.map(response => response.json());
  },
  renderDialog: (sdk) => {
    const config = sdk.parameters.invocation;

    const container = document.createElement('div');
    container.innerHTML = `<iframe src="https://example.com/products-search?category=${config.category}" />`;
    document.body.appendChild(container);
  },
  openDialog: async (sdk, currentValue, config) => {
    return await sdk.dialogs.openCurrentApp({
      parameters: { config, currentValue },
    });
  },
  isDisabled: () => false,
  productCardVersion: 'v2'
});
```

--------------------------------

### Copy Environment Example File

Source: https://github.com/contentful/apps/blob/master/apps/jira/README.md

Copy the example .env file to create your own environment configuration. You will need to edit this file with your specific credentials.

```bash
cp .env.example .env
```

--------------------------------

### Install App into a Space

Source: https://github.com/contentful/apps/blob/master/examples/function-appevent-handler/INSTRUCTIONS.md

Installs the app into a selected Contentful space and environment.

```bash
npm run install-app
```

--------------------------------

### Copy Environment File

Source: https://github.com/contentful/apps/blob/master/apps/drive-integration/README.md

Copy the example environment file to create a new configuration file.

```bash
cp .env.example .env
```

--------------------------------

### Bootstrap Custom Validation App Example

Source: https://github.com/contentful/apps/blob/master/examples/custom-validation/README.md

Use this command to bootstrap the custom validation example project locally. This sets up the necessary project structure and dependencies.

```bash
npx create-contentful-app --example custom-validation
```

```bash
npm init contentful-app -- --example custom-validation
```

```bash
yarn create contentful-app --example custom-validation
```

--------------------------------

### Bootstrap Contentful App with Vue Example

Source: https://github.com/contentful/apps/blob/master/examples/vue/README.md

Use this command to bootstrap a new Contentful app with the Vue 3 example. Choose the package manager that suits your workflow.

```bash
npx create-contentful-app --example vue
```

```bash
npm init contentful-app -- --example vue
```

```bash
yarn create contentful-app --example vue
```

--------------------------------

### Install Contentful App Template

Source: https://github.com/contentful/apps/blob/master/examples/autotagger/functions/INSTRUCTIONS.md

Use this command to initialize a new project using the function-appevent-handler template.

```bash
npx create-contentful-app@latest --example function-appevent-handler
```

--------------------------------

### Navigate to Scripts Directory

Source: https://github.com/contentful/apps/blob/master/scripts/README.md

Change the current directory to the scripts folder where the setup script is located.

```bash
cd scripts
```

--------------------------------

### View usage guide

Source: https://github.com/contentful/apps/blob/master/apps-migration-scripts/README.md

Displays the complete command reference and technical details.

```bash
cat USAGE_GUIDE.md
```

--------------------------------

### Run Local Development Server

Source: https://github.com/contentful/apps/blob/master/apps/drive-integration/README.md

Start the local development server for the drive integration app.

```bash
npm run dev
```

--------------------------------

### Manual Testing

Source: https://github.com/contentful/apps/blob/master/apps-migration-scripts/GETTING_STARTED.md

Commands to manually build and start the migrated application for verification.

```bash
# Navigate to the migrated app
cd ../apps/<app-name>

# Install dependencies (if not done automatically)
npm install

# Try to build
npm run build

# Try to start
npm start
```

--------------------------------

### Install Contentful Function Template

Source: https://github.com/contentful/apps/blob/master/function-examples/external-references/typescript/INSTRUCTIONS.md

Use this command to initialize a new project with the external-references function template.

```bash
npx create-contentful-app@latest --function external-references
```

--------------------------------

### Bootstrap Mock.shop App with npx

Source: https://github.com/contentful/apps/blob/master/examples/function-mock-shop/README.md

Execute this command to bootstrap the mock.shop example application using create-contentful-app.

```bash
npx create-contentful-app@latest --example function-mock-shop
```

--------------------------------

### Run Phosphor Icon App Locally

Source: https://github.com/contentful/apps/blob/master/apps/phosphor-icon/README.md

Starts the Phosphor Icon app for local development. Ensure you have dependencies installed first.

```bash
npm ci
npm start -- --host localhost --port 3001
```

--------------------------------

### Create App Definition

Source: https://github.com/contentful/apps/blob/master/apps/link-checker/README.md

Initializes a new app definition within your Contentful organization. This command guides you through the setup process and can store organization and app IDs for future use.

```bash
npm run create-app-definition
```

--------------------------------

### Install Dependencies

Source: https://github.com/contentful/apps/blob/master/apps/google-analytics-4/README.md

Installs or updates the necessary dependencies for the app locally.

```sh
npm i
```

--------------------------------

### Example search and lookup requests

Source: https://github.com/contentful/apps/blob/master/examples/native-external-references-tmdb/README.md

Example implementations of search and lookup event requests.

```typescript
const searchRequest: ResourcesSearchRequest = {
  type: 'resources.search',
  resourceType: 'TMDB:Person',
  query: 'Tom'
};
```

```typescript
const lookupRequest: ResourcesLookupRequest = {
  type: 'resources.lookup',
  resourceType: 'TMDB:Person',
  lookupBy: {
    urn: ['31', '1245']
  }
};
```

--------------------------------

### Bootstrap the Contentful App

Source: https://github.com/contentful/apps/blob/master/examples/default-values-backend/README.md

Use these commands to initialize the demo application using npm, npx, or yarn.

```bash
# npx
npx create-contentful-app --example default-values-backend

# npm
npm init contentful-app -- --example default-values-backend

# Yarn
yarn create contentful-app --example default-values-backend
```

--------------------------------

### Install Lambda Dependencies

Source: https://github.com/contentful/apps/blob/master/apps/jira/README.md

Ensure that the dependencies for the Lambda functions are installed. This is necessary if you encounter 'rimraf: command not found' errors.

```bash
cd apps/jira/functions && npm install
```

--------------------------------

### Initialize DAM App with setup

Source: https://github.com/contentful/apps/blob/master/packages/dam-app-base/README.md

Configures the DAM app integration by defining metadata, parameter requirements, and dialog rendering logic.

```javascript
import { setup } from '@contentful/dam-app-base';

setup({
  cta: 'Select assets',
  name: 'My DAM App',
  logo: 'https://example.com/logo.svg',
  color: '#d7f0fa',
  description: 'My example DAM App',
  parameterDefinitions: [
    {
      "id": "folder",
      "type": "Symbol",
      "name": "Folder",
      "description": "Preselected folder when selecting assets.",
      "required": true
    }
  ],
  validateParameters: () => null,
  makeThumbnail: asset => asset.thumbnailUrl,
  renderDialog: async (sdk) => {
    const config = sdk.parameters.invocation;

    const container = document.createElement('div');
    container.innerHTML = `<iframe src="https://example.com/dam?folder=${config.folder}" />`;
    document.body.appendChild(container);
  },
  openDialog: async (sdk, currentValue, config) => {
    return await sdk.dialogs.openCurrentApp({
      parameters: { config, currentValue },
    });
  },
  isDisabled: () => false
});
```

--------------------------------

### Start Docker Compose Services

Source: https://github.com/contentful/apps/blob/master/apps/google-analytics-4/README.md

Starts all services defined in the Docker Compose file, displaying logs in real-time. Use this to bring up the development environment.

```bash
docker compose up --build
```

--------------------------------

### Example: Add Content Filter Function (Non-interactive)

Source: https://github.com/contentful/apps/blob/master/function-examples/appevent-filter/typescript/INSTRUCTIONS.md

An example of using the non-interactive command to add a content filter function named 'content-filter' using TypeScript.

```bash
npx --no-install @contentful/app-scripts generate-function --ci --name content-filter --example appevent-filter --language typescript
```

--------------------------------

### Example: Non-interactive Function Generation

Source: https://github.com/contentful/apps/blob/master/function-examples/appevent-filter/javascript/INSTRUCTIONS.md

This example demonstrates how to use the non-interactive mode to generate an app event filter function named 'content-filter' using JavaScript.

```bash
npx --no-install @contentful/app-scripts generate-function --ci --name content-filter --example appevent-filter --language javascript
```

--------------------------------

### Bootstrap E-Commerce App

Source: https://github.com/contentful/apps/blob/master/examples/ecommerce-app/README.md

Use these commands to initialize the e-commerce demo application via the Contentful CLI.

```bash
# npx
npx create-contentful-app --example ecommerce-app

# npm
npm init contentful-app -- --example ecommerce-app

# Yarn
yarn create contentful-app --example ecommerce-app
```

--------------------------------

### Access help documentation

Source: https://github.com/contentful/apps/blob/master/apps-migration-scripts/GETTING_STARTED.md

Use the help flag to view available commands and guidance.

```bash
<script> --help
```

--------------------------------

### Example: Non-interactive App Action Function Generation

Source: https://github.com/contentful/apps/blob/master/function-examples/appaction-call/javascript/INSTRUCTIONS.md

This example demonstrates the non-interactive command to generate an App Action function named 'content-processor' using the 'appaction-call' template and JavaScript.

```bash
npx --no-install @contentful/app-scripts generate-function --ci --name content-processor --example appaction-call --language javascript
```

--------------------------------

### Fetch Locales using Contentful Management SDK

Source: https://github.com/contentful/apps/blob/master/apps/slack/frontend/README.md

Example of using the contentful-management client, passed into each location, to interact with Contentful's Management API. This specific example fetches all available locales.

```javascript
  // Use the client
  cma.locale.getMany({}).then((locales) => console.log(locales))
```

--------------------------------

### Entry Editor Location Setup

Source: https://github.com/contentful/apps/blob/master/apps/json-viewer/AGENTS.md

This snippet shows the typical setup for the Entry Editor location, which replaces the entire entry editor UI. It emphasizes the use of `useAutoResizer()` for variable content height.

```typescript
import React from 'react';
import { useAutoResizer, useSDK } from '@contentful/react-apps-toolkit';

const EntryEditor = () => {
  const sdk = useSDK();
  useAutoResizer(); // Essential for variable content height

  // ... rest of the editor logic

  return <div>JSON Viewer Content</div>;
};

export default EntryEditor;
```

--------------------------------

### App Event Filter Function Example

Source: https://github.com/contentful/apps/blob/master/function-examples/appevent-filter/javascript/INSTRUCTIONS.md

Implement this JavaScript function to process specific app events. This example filters events to include only those for the 'blogPost' content type, discarding all others. It requires the event and context objects as parameters.

```javascript
exports.handler = function(event, context) {
  const { body } = event;

  // Process events only for the 'blogPost' content type
  if (body.sys?.contentType?.sys?.id === 'blogPost') { 
    return { result: true }; 
  }

  // Discard all other events 
  return { result: false };
};
```

--------------------------------

### Install Contentful App Template

Source: https://github.com/contentful/apps/blob/master/function-examples/external-references/javascript/INSTRUCTIONS.md

Use this command to initialize a new Contentful app project with function support.

```bash
npx create-contentful-app@latest --javascript --function external-references
```