### Start Local MongoDB with Docker

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/lowcoder-extension/opensource-contribution/README.md

Use this command to start a local MongoDB instance for development purposes. Ensure Docker is installed and running.

```bash
docker run -d  --name lowcoder-mongodb -p 27017:27017 -e MONGO_INITDB_DATABASE=lowcoder mongo
```

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

### Start Local Redis with Docker

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/lowcoder-extension/opensource-contribution/README.md

Use this command to start a local Redis instance for development purposes. Ensure Docker is installed and running.

```bash
docker run -d --name lowcoder-redis -p 6379:6379 redis
```

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

### Basic GET Request

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/axios/README.md

Demonstrates how to make a GET request to fetch data, with examples using both query parameters and a params object.

```APIDOC
## GET /user

### Description
Fetches user data. Can be done by appending query parameters to the URL or by using the `params` config object.

### Method
GET

### Endpoint
/user

### Parameters
#### Query Parameters
- **ID** (number) - Required - The ID of the user to fetch.

### Request Example
```javascript
// Using query parameters in URL
axios.get('/user?ID=12345')
  .then(function (response) { /* handle success */ })
  .catch(function (error) { /* handle error */ });

// Using params object
axios.get('/user', {
    params: {
      ID: 12345
    }
  })
  .then(function (response) { /* handle success */ })
  .catch(function (error) { /* handle error */ });
```

### Response
#### Success Response (200)
- **data** (any) - The data returned from the server.

#### Response Example
```json
{
  "data": { /* user data */ }
}
```
```

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

### Build and Start Node.js Production Server

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/lowcoder-extension/opensource-contribution/README.md

Build the Node.js service for production and then start it.

```bash
yarn build 
yarn start
```

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

### Install create-require

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/create-require/README.md

Install the package using either yarn or npm.

```sh
yarn add create-require
```

```sh
npm install create-require
```

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

### Install with Custom Source Map Retrieval

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/@cspotcode/source-map-support/README.md

Provide a `retrieveSourceMap` callback to customize how source maps are loaded, for example, to cache them in memory.

```javascript
require('@cspotcode/source-map-support').install({
  retrieveSourceMap: function(source) {
    if (source === 'compiled.js') {
      return {
        url: 'original.js',
        map: fs.readFileSync('compiled.js.map', 'utf8')
      };
    }
    return null;
  }
});
```

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

### Install Source Map Support

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/@cspotcode/source-map-support/README.md

Install the package using npm. This is the first step before using the module.

```bash
$ npm install @cspotcode/source-map-support
```

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

### Install @jridgewell/trace-mapping

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/@jridgewell/trace-mapping/README.md

Install the package using npm.

```sh
npm install @jridgewell/trace-mapping
```

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

### Arg Output Example

Source: https://github.com/lowcoder-org/lowcoder/blob/main/translations/locales/node_modules/arg/README.md

Illustrates the expected output structure from parsing the arguments defined in the previous example.

```javascript
/*
{
	_: ["foo", "bar", "--foobar"],
	'--port': 1234,
	'--verbose': 4,
	'--name': "My name",
	'--tag': ["qux", "qix"]
}
*/
```

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

### Install General Dependencies

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/lowcoder-extension/opensource-contribution/README.md

Navigate to the root folder of your cloned repository and install general dependencies using Yarn.

```bash
yarn install
```

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

### Install yn

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/yn/readme.md

Install the yn package using npm.

```bash
$ npm install yn
```

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

### Install Arg with NPM

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/arg/README.md

Install the 'arg' package using NPM.

```bash
npm install arg
```

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

### Install lowcoder-sdk with Yarn

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/packages/lowcoder-sdk/README.md

Install the lowcoder-sdk package using Yarn.

```bash
yarn add lowcoder-sdk
```

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

### Install form-data Package

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/form-data/Readme.md

Install the form-data package using npm. This is the first step before using the library in your project.

```bash
npm install --save form-data
```

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

### Install Netlify CLI

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/README.md

Installs the Netlify Command Line Interface globally. This is a prerequisite for local Netlify deployments.

```bash
npm install -g netlify-cli
```

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

### Programmatic Usage with Install

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/@cspotcode/source-map-support/README.md

Call the `install()` function at the top of your compiled JavaScript file to enable source map support.

```javascript
require('@cspotcode/source-map-support').install();
```

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

### Install strip-bom with npm

Source: https://github.com/lowcoder-org/lowcoder/blob/main/translations/locales/node_modules/strip-bom/readme.md

Install the `strip-bom` package using npm. This is the first step before using the module in your Node.js project.

```bash
$ npm install --save strip-bom
```

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

### Start Local Backend Server

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/lowcoder-extension/opensource-contribution/develop-data-source-plugins.md

Instructions to start a local backend server for testing data source plugins. This involves cloning the server repository and running the development command.

```bash
yarn dev
```

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

### Start Development Server

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/packages/lowcoder-plugin-demo/README.md

Run this command to start the development server for your component library. This allows for live reloading and testing during development.

```bash
yarn start
```

```bash
npm start
```

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

### Start Prebuilt Docker Backend

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/README.md

Run this command to start a prebuilt Lowcoder backend server using Docker. Mounts local stacks directory for persistence.

```bash
docker run -d --name lowcoder -p 3000:3000 -v "$PWD/stacks:/lowcoder-stacks" lowcoderorg/lowcoder-ce
```

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

### Token Server Response Example

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/build-applications/video-calls-in-lowcoder.md

The Token Server responds with a JSON object containing both the rtcToken and rtmToken, which are necessary for starting an Agora meeting.

```json
{
  "rtcToken": "007eJxSYC ... wACAAD//+loLdY=",
  "rtmToken": "007eJxSYH ... MPCAAA//+1IzWK"
}
```

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

### Start Plugin Development Server

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/lowcoder-extension/opensource-contribution/README.md

Start the local development server for your plugin. This command also opens a browser window for real-time preview of your component in the playground.

```bash
yarn start
```

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

### Get Files File

Source: https://github.com/lowcoder-org/lowcoder/blob/main/server/node-service/src/plugins/stripe/stripe.spec_old.txt

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, refer to the File Upload Guide.

```APIDOC
## GET /v1/files/{file}

### Description
Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the <a href="/docs/file-upload#download-file-contents">File Upload Guide</a>.

### Method
GET

### Endpoint
/v1/files/{file}

### Parameters
#### Path Parameters
- **file** (string) - Required - The ID of the file to retrieve.

#### Query Parameters
- **expand** (array) - Optional - Specifies which fields in the response should be expanded.

### Response
#### Success Response (200)
- **file** (object) - The file object details.

#### Error Response
- **error** (object) - An error object if the request fails.
```

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

### Start Lowcoder Extra Components Dev Server

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/packages/lowcoder-comps/README.md

Navigate to the lowcoder-comps directory and start the development server to build and preview components.

```bash
cd client/packages/lowcoder-comps
yarn start
```

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

### Install proxy-from-env

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/proxy-from-env/README.md

Install the package using npm.

```sh
npm install proxy-from-env
```

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

### Start Docker Backend from Source

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/README.md

Starts a Lowcoder backend server from a locally built Docker image. Mounts local stacks directory.

```bash
docker run -d --name lowcoder-dev -p 3000:3000 -v "$PWD/stacks:/lowcoder-stacks" lowcoder-dev
```

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

### Install and Run CoffeeScript Demo

Source: https://github.com/lowcoder-org/lowcoder/blob/main/translations/locales/node_modules/@cspotcode/source-map-support/README.md

Demonstrates how to install the source-map-support and coffeescript packages, compile a CoffeeScript file, and run the resulting JavaScript. Shows the expected error output with source map support enabled.

```coffee
require('@cspotcode/source-map-support').install()
foo = ->
  bar = -> throw new Error 'this is a demo'
  bar()
foo()
```

```sh
$ npm install @cspotcode/source-map-support coffeescript
$ node_modules/.bin/coffee --map --compile demo.coffee
$ node demo.js
```

```text
demo.coffee:3
  bar = -> throw new Error 'this is a demo'
                     ^
Error: this is a demo
    at bar (demo.coffee:3:22)
    at foo (demo.coffee:4:3)
    at Object.<anonymous> (demo.coffee:5:1)
    at Object.<anonymous> (demo.coffee:1:1)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
```

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

### Install @jridgewell/resolve-uri

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/@jridgewell/resolve-uri/README.md

Install the package using npm.

```sh
npm install @jridgewell/resolve-uri
```

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

### Start Frontend Development Server

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/README.md

Starts the Lowcoder frontend development server. Ensure the backend API service URL is correctly set.

```bash
LOWCODER_API_SERVICE_URL=http://localhost:3000 yarn start
```

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

### Install ts-node Locally or Globally

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/ts-node/README.md

Install ts-node and TypeScript locally within your project or globally on your system. Local installation is recommended for version control.

```shell
# Locally in your project.
npm install -D typescript
npm install -D ts-node

# Or globally with TypeScript.
npm install -g typescript
npm install -g ts-node

# Depending on configuration, you may also need these
npm install -D tslib @types/node
```

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

### Install Lowcoder Node via UI

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/workflows/n8n-integration.md

Install the Lowcoder Community Node for n8n through the n8n user interface. This is the recommended method for self-hosted n8n installations.

```bash
n8n-nodes-lowcoder
```

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

### Install mime-types

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/mime-types/README.md

Install the mime-types module using npm.

```sh
npm install mime-types
```

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

### Install mime-db

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/mime-db/README.md

Install the mime-db package using npm.

```bash
npm install mime-db
```

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

### Install delayed-stream

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/delayed-stream/Readme.md

Install the delayed-stream module using npm.

```bash
npm install delayed-stream
```

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

### Install and Compile CoffeeScript with Source Maps

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/@cspotcode/source-map-support/README.md

Demonstrates installing the source-map-support and coffeescript packages, compiling a CoffeeScript file with source map support, and running the resulting JavaScript file. Shows the expected error output with source map information.

```sh
$ npm install @cspotcode/source-map-support coffeescript
$ node_modules/.bin/coffee --map --compile demo.coffee
$ node demo.js
```

```coffeescript
require('@cspotcode/source-map-support').install()
foo = ->
  bar = -> throw new Error 'this is a demo'
  bar()
foo()
```

```text
demo.coffee:3
  bar = -> throw new Error 'this is a demo'
                     ^
Error: this is a demo
    at bar (demo.coffee:3:22)
    at foo (demo.coffee:4:3)
    at Object.<anonymous> (demo.coffee:5:1)
    at Object.<anonymous> (demo.coffee:1:1)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
```

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

### Creating an Axios Instance

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/axios/README.md

Explains how to create a custom Axios instance with predefined configurations.

```APIDOC
## axios.create([config])

### Description
Creates a new Axios instance with a custom configuration, allowing for reusable settings like baseURL and headers.

### Parameters
#### Config Options
- **baseURL** (string) - The base URL for requests made with this instance.
- **timeout** (number) - The number of milliseconds before the request times out.
- **headers** (object) - Default headers to be sent with requests.

### Request Example
```javascript
const instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});
```
```

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

### Install combined-stream

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/combined-stream/Readme.md

Install the combined-stream module using npm.

```bash
npm install combined-stream
```

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

### Cancel a Setup Intent

Source: https://github.com/lowcoder-org/lowcoder/blob/main/server/node-service/src/plugins/stripe/stripe.spec_old.txt

Cancels a SetupIntent object. This is useful when a setup intent is in a state that requires payment method, confirmation, or action, and you wish to abandon the setup process.

```APIDOC
## POST /v1/setup_intents/{intent}/cancel

### Description
<p>A SetupIntent object can be canceled when it is in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>.</p>

<p>Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.</p>

### Method
POST

### Endpoint
/v1/setup_intents/{intent}/cancel

### Parameters
#### Path Parameters
- **intent** (string) - Required - The ID of the SetupIntent to cancel.

### Request Body
(No request body is specified in the source for this operation)

### Response
#### Success Response (200)
(Schema not provided in source)

#### Response Example
(No example provided in source)
```

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

### Install Lowcoder SDK Dependencies

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/packages/lowcoder-comps/README.md

Navigate to the lowcoder-sdk directory and build the SDK before developing extra components.

```bash
cd client/packages/lowcoder-sdk
yarn build
```

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

### Install Arg with Yarn

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/arg/README.md

Install the 'arg' package using Yarn.

```bash
yarn add arg
```

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

### Build Lowcoder Plugins with Maven

Source: https://github.com/lowcoder-org/lowcoder/blob/main/server/api-service/README.md

Navigate to the api-service directory and run this command to build the project and all lowcoder-plugins, which is a prerequisite for starting the server.

```shell
cd server/api-service

mvn clean package
```

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

### TypeScript Demo: Compile and Run

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/@cspotcode/source-map-support/README.md

Commands to install dependencies, compile TypeScript with source maps, and run the compiled JavaScript.

```bash
$ npm install source-map-support typescript
$ node_modules/typescript/bin/tsc -sourcemap demo.ts
$ node demo.js
```

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

### Example Project Structure for Type Roots

Source: https://github.com/lowcoder-org/lowcoder/blob/main/node_modules/ts-node/README.md

Illustrates the expected directory structure when using `typeRoots` to manage custom type definitions.

```text
<project_root>/
-- tsconfig.json
-- typings/
  -- <module_name>/
    -- index.d.ts
```

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

### Install lowcoder-sdk with npm

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/packages/lowcoder-sdk/README.md

Install the lowcoder-sdk package using npm.

```bash
npm install lowcoder-sdk
```

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

### Configure Netlify Build Settings

Source: https://github.com/lowcoder-org/lowcoder/blob/main/client/README.md

Example netlify.toml configuration for the Lowcoder client. This file should be placed in the 'client/' directory.

```toml
[build]
  base = "client"
  command = "yarn workspace lowcoder build"
  publish = "client/packages/lowcoder/build"
```

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

### Install Lowcoder Node in Docker

Source: https://github.com/lowcoder-org/lowcoder/blob/main/docs/workflows/n8n-integration.md

Install the Lowcoder Community Node for n8n when running n8n in a Docker container. Use the mounted \"/custom\" folder for installation.

```bash
mkdir ~/.n8n/custom
cd ~/.n8n/custom
npm install n8n-nodes-lowcoder
```