client/packages/lowcoder-plugin-demo/yarn.lock

client/packages/lowcoder-plugin-demo/.yarn/cache/@types-node-npm-16.18.68-56f72825c0-094ae9ed80.zip

server/api-service/lowcoder-server/src/main/resources/application-lowcoder.yml

server/api-service/lowcoder-server/src/main/resources/application-debug.yaml

.vscode/settings.json

.vscode/launch.json

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

Configure the MongoDB connection URI in the application-lowcoder.yml

Configure the MongoDB connection URI in theserver/api-service/lowcoder-server/src/main/resources/application-lowcoder.yml

If you don't have an availableMongoDB, you can start a local Redis service with docker:

If you don't have an availableRedis, you can start a local Redis service with docker:

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

Configure the Redis connection URI in the application-lowcoder.yml

<imgsrc="../../docs/.gitbook/assets/server-setup-image2.png"/>

Configure the Redis connection URI in the server/api-service/lowcoder-server/src/main/resources/application-lowcoder.yml

Now you can clone the Repository from Github:https://github.com/lowcoder-org/lowcoder

git@github.com:lowcoder-org/lowcoder.git

Create a launch.json file in the .vscode folder of your new opened workspace.

The contents should look like this:

{

"version":"0.0.1",

"configurations": [

{

"type":"java",

"name":"ServerApplication",

"request":"launch",

"mainClass":"org.lowcoder.api.ServerApplication",

"projectName":"Lowcoder API Service",

"vmArgs":"-Dpf4j.mode=development -Dpf4j.pluginsDir=lowcoder-plugins -Dspring.profiles.active=lowcoder -XX:+AllowRedefinitionToAddDeleteMethods --add-opens java.base/java.nio=ALL-UNNAMED"

}

],

}

1. Clone Lowcoder repository

2. Next, execute the following commands in sequence

cd server

cd server/api-service

mvn clean package

java -Dpf4j.mode=development -Dspring.profiles.active=lowcoder -Dpf4j.pluginsDir=lowcoder-plugins -jar lowcoder-server/target/lowcoder-server-1.0-SNAPSHOT.jar

java -Dpf4j.mode=development -Dspring.profiles.active=lowcoder -Dpf4j.pluginsDir=lowcoder-plugins -jar lowcoder-server/target/lowcoder-api-service.jar

<imgsrc="../../docs/.gitbook/assets/server-setup-start.gif"/>

Now, you can check the status of the service by visitinghttp://localhost:8080 through your browser. By default, you should see an HTTP 404 error.

Configure the Run/Debug configuration as shown in the screenshot below, the version used in the screenshot is IntelliJ

IDEA 2021.3.2 (Community Edition):

<imgsrc="../../docs/.gitbook/assets/server-setup-image4.png"/>

<imgsrc="../../docs/.gitbook/assets/server-setup-image5.png"/>

Configure the Run/Debug configuration as shown below.

<table>

After Maven package runs successfully, you can start the Lowcoder server with IntelliJ IDEA.

For information on how to contribute to Lowcoder, please view our[Contribution Guide](https://docs.lowcoder.cloud/lowcoder-documentation/lowcoder-extension/opensource-contribution).

data:

mongodb:

authentication-database:admin

uri:"mongodb://lowcoder:secret123@127.0.0.1:37017/lowcoder?authSource=admin"

uri:"mongodb://lowcoder:secret123@127.0.0.1:27017/lowcoder?authSource=admin"

redis:

url:"redis://127.0.0.1:16379"

url:"redis://127.0.0.1:6379"

server:

port:18080

port:8080

common:

cookie-name:LOWCODER_DEBUG_TOKEN

js-executor:

host:"http://127.0.0.1:16060"

host:"http://127.0.0.1:6060"

workspace:

mode:SAAS

mongodb:

authentication-database:admin

auto-index-creation:false

uri:mongodb://localhost:27017/lowcoder?authSource=admin

uri:mongodb://localhost:27017/secret123@mongodb/lowcoder?authSource=admin

redis:

url:redis://localhost:6379

main:

mongodb:

authentication-database:admin

auto-index-creation:false

uri:${LOWCODER_MONGODB_URL:mongodb://localhost:27017/lowcoder?authSource=admin}

uri:${LOWCODER_MONGODB_URL:mongodb://lowcoder:secret123@127.0.0.1:27017/lowcoder?authSource=admin}

redis:

url:${LOWCODER_REDIS_URL:redis://localhost:6379}

main:

Writedata source pluginswith TypeScript.

Lowcoder Node Service is a powerful tool to develop and hostdata source pluginsusing TypeScript.

To start developing data source plugins, follow these simple steps:

1. Clone the Repository

You can clone the Repository from Github:https://github.com/lowcoder-org/lowcoder

git@github.com:lowcoder-org/lowcoder.git

2. Navigate to the Node Service directory in the Lowcoder Repository.

3. Install dependencies.

yarn install

4. Start the development server.

yarn dev

A data source plugin in Lowcoder is a JavaScript Object that defines various aspects of a data source, including its basic information, configuration form, validation logic, query configurations, and execution logic.

Each plugin is described by an object conforming to the`DataSourcePlugin` interface. Here's a brief overview:

-`id`: A unique identifier for the plugin.

-`name`: Display name of the plugin.

-`description`: Brief description of the plugin.

-`icon`: File name of the icon representing the plugin.

-`category`: Category of the data source (e.g., database, API).

-`dataSourceConfig`: Configuration form of the data source.

-`queryConfig`: Configuration for data source queries.

-`validateDataSourceConfig`: Validation logic for the data source configuration.

-`run`: Execution logic for data source queries.

To develop a data source plugin, you'll mainly focus on:

-**Defining the basic information** of the plugin.

-**Defining the configuration form** of the data source.

-**Implementing the validation logic** for the configuration.

-**Defining the action list** for data source queries.

-**Implementing the execution logic** for actions.

For detailed information on how to develop a plugin, refer to our[detailed Guide](https://docs.lowcoder.cloud/lowcoder-documentation/lowcoder-extension/develop-data-source-plugins).

For information on how to contribute to Lowcoder, please view our[Contribution Guide](https://docs.lowcoder.cloud/lowcoder-documentation/lowcoder-extension/opensource-contribution).

Before publishing your plugin, it's crucial to test it thoroughly. Follow these steps:

1. Ensure your plugin is added to the plugin list in`src/plugins/index.ts`.

2. Start the`node-service` server by executing`yarn dev`.

3. Modify the backend configuration using the provided commands in the testing section of the guide.

Feel free to modify this readme according to your needs. If you have any questions or need further assistance, don't hesitate to reach out!

yarn&& yarn build&& yarn start

yarn build

yarn start