Support Contribute with Gitpod. (apache#5610)

Co-authored-by: xiaoyu <[email protected]>

.devcontainer/devcontainer.json

@@ -0,0 +1,38 @@
+{
+  "name": "Shenyu DevContainer",
+  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+  "features": {
+      "ghcr.io/devcontainers/features/java:1": {
+          "version": "17",
+          "installMaven": "true",
+          "installGradle": "false"
+      },
+      "ghcr.io/devcontainers/features/node:1": {
+          "version": "20"
+      },
+      "ghcr.io/devcontainers/features/git-lfs:1.1.0": {}
+  },
+  "customizations": {
+      "vscode": {
+          "settings": {},
+          // same extensions as Gitpod, should match /.gitpod.yml
+          "extensions": [
+              "vscjava.vscode-java-pack",
+              "editorconfig.editorconfig",
+              "dbaeumer.vscode-eslint",
+              "stylelint.vscode-stylelint",
+              "DavidAnson.vscode-markdownlint",
+              "ms-azuretools.vscode-docker",
+              "cweijan.vscode-database-client2",
+              "GitHub.vscode-pull-request-github"
+          ]
+      }
+  },
+  "portsAttributes": {
+      "8000": {
+          "label": "Shenyu Admin",
+          "onAutoForward": "notify"
+      }
+  },
+  "postCreateCommand": "java -version"
+}

.gitpod.yml

@@ -0,0 +1,51 @@
+additionalRepositories:
+    - url: https://github.com/apache/shenyu-dashboard.git
+      checkoutLocation: frontend
+
+tasks:
+
+    - name: Run backend
+      before: cd ./shenyu-admin
+      command: |
+          gp sync-await setup-backend
+          mvn spring-boot:run
+
+    - name: Run frontend
+      before: cd ../frontend
+      command: |
+          gp sync-await setup-frontend && gp ports await 9095
+          npm start
+      openMode: split-right
+
+    - name: Setup backend
+      init: |
+          sdk install java 17.0.11.fx-zulu < /dev/null
+          sdk default java 17.0.11.fx-zulu < /dev/null
+          mvn clean install -DskipTests
+      command: |
+          gp sync-done setup-backend
+          exit 0
+
+    - name: Setup frontend
+      before: cd ../frontend
+      init: |
+          npm install
+      command: |
+          gp sync-done setup-frontend
+          exit 0
+      openMode: split-right
+
+vscode:
+    extensions:
+        - vscjava.vscode-java-pack
+        - editorconfig.editorconfig
+        - dbaeumer.vscode-eslint
+        - stylelint.vscode-stylelint
+        - DavidAnson.vscode-markdownlint
+        - ms-azuretools.vscode-docker
+        - cweijan.vscode-database-client2
+        - GitHub.vscode-pull-request-github
+
+ports:
+    - port: 9095
+      onOpen: ignore

.licenserc.yaml

@@ -39,6 +39,7 @@ header:
     - '**/.gitignore'
     - '**/.gitmodules'
     - '**/.git/**'
+    - '**/.gitpod.yml'
     - '**/.travis.yml'
     - '**/.codecov.yml'
     - '**/.mvn/jvm.config'

README.md

@@ -45,6 +45,9 @@
   <a target="_blank" href="https://hub.docker.com/r/apache/shenyu-bootstrap/tags">
     <image src="https://img.shields.io/docker/pulls/apache/shenyu-bootstrap" alt="Docker Pulls"/>
   </a>
+  <a target="_blank" href="https://gitpod.io/#https://github.com/apache/shenyu">
+    <image src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod&color=green"/>
+  </a>
 </p>
 <br/>
 

pom.xml

@@ -396,7 +396,7 @@
                 <artifactId>pagehelper</artifactId>
                 <version>${pagehelper.version}</version>
             </dependency>
-            
+
             <dependency>
                 <groupId>org.springdoc</groupId>
                 <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
@@ -783,6 +783,8 @@
                         <exclude>**/.mvn/wrapper/maven-wrapper.properties</exclude>
                         <!-- GitHub files -->
                         <exclude>**/.github/**</exclude>
+                        <!-- Gitpod files -->
+                        <exclude>**/.gitpod.yml</exclude>
                         <!-- document files -->
                         <exclude>**/*.md</exclude>
                         <excldue>**/*.MD</excldue>