Updating Readme Files for API-Service and Node-Service

Author: FalkWolsky

.gitignore

@@ -10,3 +10,7 @@ client/packages/lowcoder-plugin-demo/.yarn/install-state.gz
 client/packages/lowcoder-plugin-demo/yarn.lock
 client/packages/lowcoder-plugin-demo/.yarn/cache/@types-node-npm-16.18.68-56f72825c0-094ae9ed80.zip
 application-dev.yml
+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

server/api-service/README.md

@@ -14,42 +14,65 @@ If you don't have an available MongoDB, you can start a local MongoDB service wi
 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
-<img src="../../docs/.gitbook/assets/server-setup-image1.png"/>
+Configure the MongoDB connection URI in the server/api-service/lowcoder-server/src/main/resources/application-lowcoder.yml
+
 
 ### Redis
 
-If you don't have an available MongoDB, you can start a local Redis service with docker:
+If you don't have an available Redis, you can start a local Redis service with docker:
 
 ```shell
 docker run -d --name lowcoder-redis -p 6379:6379 redis
 ```
 
-Configure the Redis connection URI in the application-lowcoder.yml
-<img src="../../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
+
+## Clone the Repository
+
+Now you can clone the Repository from Github: https://github.com/lowcoder-org/lowcoder
+
+```shell
+git@github.com:lowcoder-org/lowcoder.git
+```
+
+## Unsing VS Code
+
+Create a launch.json file in the .vscode folder of your new opened workspace.
+The contents should look like this:
+
+```JSON
+{
+    "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"
+        }
+    ],
+}
+```
 
 ## Build and start the Lowcoder server jar
 
 1. Clone Lowcoder repository
 2. Next, execute the following commands in sequence
 
 ```shell
-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
 ```
 
-<img src="../../docs/.gitbook/assets/server-setup-start.gif"/>
-Now, you can check the status of the service by visiting http://localhost:8080 through your browser. By default, you should see an HTTP 404 error.
 
-<img src="../../docs/.gitbook/assets/server-setup-image3.png"/>
+Now, you can check the status of the service by visiting http://localhost:8080 through your browser. By default, you should see an HTTP 404 error.
 
-## Start with IntelliJ IDEA
+## Unsing IntelliJ IDEA
 
-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):
-<img src="../../docs/.gitbook/assets/server-setup-image4.png"/>
-<img src="../../docs/.gitbook/assets/server-setup-image5.png"/>
+Configure the Run/Debug configuration as shown below.
 
 <table>
     <tr>
@@ -78,3 +101,5 @@ mvn clean package
 ```
 
 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).

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

@@ -2,16 +2,16 @@ spring:
   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
 

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

@@ -3,7 +3,7 @@ spring:
     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:

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

@@ -11,7 +11,7 @@ spring:
     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:

server/node-service/README.md

@@ -1,17 +1,87 @@
-# Node Service
+# Welcome to Lowcoder Node Service
 
-Write data source plugins with TypeScript.
+Lowcoder Node Service is a powerful tool to develop and host data source plugins using TypeScript.
 
-- [How to write data source plugin](#)
+## Getting Started
 
-### Develop
+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
+
+```shell
+git@github.com:lowcoder-org/lowcoder.git
+```
+
+2. Navigate to the Node Service directory in the Lowcoder Repository.
 
 ```bash
-yarn && yarn dev
+cd server/node-service
 ```
 
-### Production
+3. Install dependencies.
+
+```bash
+yarn install
+```
+
+4. Start the development server.
+
+```bash
+yarn dev
+```
+
+## What is a Data Source Plugin?
+
+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.
+
+### Overall Definition of a Plugin
+
+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.
+
+## Developing Data Source Plugins
+
+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.
+
+### All plugins reside in the directory server/node-service/src/plugins
+
+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).
+
+
+## Testing Your Plugin
+
+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!
+
+## Run the Node Service in Production
 
 ```bash
-yarn && yarn build && yarn start
+yarn build
+yarn start
 ```