Initial commit

.github/workflows/ci.yaml

@@ -0,0 +1,15 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci:
+    uses: halo-sigs/reusable-workflows/.github/workflows/plugin-ci.yaml@v1
+    with:
+      ui-path: "ui"

.gitignore

@@ -0,0 +1,75 @@
+### Maven
+target/
+logs/
+!.mvn/wrapper/maven-wrapper.jar
+
+### Gradle
+.gradle
+/build/
+/out/
+!gradle/wrapper/gradle-wrapper.jar
+bin/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+log/
+
+### NetBeans ###
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+.nb-gradle/
+
+### Mac
+.DS_Store
+*/.DS_Store
+
+### VS Code ###
+*.project
+*.factorypath
+
+### Compiled class file
+*.class
+
+### Log file
+*.log
+
+### BlueJ files
+*.ctxt
+
+### Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+### Package Files
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+### VSCode
+.vscode
+
+### Local file
+application-local.yml
+application-local.yaml
+application-local.properties
+
+/ui/node_modules/
+/workplace/
+/src/main/resources/console/

OWNERS

@@ -0,0 +1,10 @@
+reviewers:
+- ruibaby
+- guqing
+- JohnNiang
+- wangzhen-fit2cloud
+
+approvers:
+- ruibaby
+- guqing
+- JohnNiang

README.md

@@ -0,0 +1,76 @@
+# plugin-starter
+
+Halo 2.0 插件开发快速开始模板。
+
+## 开发环境
+
+插件开发的详细文档请查阅：<https://docs.halo.run/developer-guide/plugin/introduction>
+
+所需环境：
+
+1. Java 17
+2. Node 20
+3. pnpm 9
+4. Docker (可选)
+
+克隆项目：
+
+```bash
+git clone [email protected]:halo-sigs/plugin-starter.git
+
+# 或者当你 fork 之后
+
+git clone [email protected]:{your_github_id}/plugin-starter.git
+```
+
+```bash
+cd path/to/plugin-starter
+```
+
+### 运行方式 1（推荐）
+
+> 此方式需要本地安装 Docker
+
+```bash
+# macOS / Linux
+./gradlew pnpmInstall
+
+# Windows
+./gradlew.bat pnpmInstall
+```
+
+```bash
+# macOS / Linux
+./gradlew haloServer
+
+# Windows
+./gradlew.bat haloServer
+```
+
+执行此命令后，会自动创建一个 Halo 的 Docker 容器并加载当前的插件，更多文档可查阅：<https://docs.halo.run/developer-guide/plugin/basics/devtools>
+
+### 运行方式 2
+
+> 此方式需要使用源码运行 Halo
+
+编译插件：
+
+```bash
+# macOS / Linux
+./gradlew build
+
+# Windows
+./gradlew.bat build
+```
+
+修改 Halo 配置文件：
+
+```yaml
+halo:
+  plugin:
+    runtime-mode: development
+    fixedPluginPath:
+      - "/path/to/plugin-starter"
+```
+
+最后重启 Halo 项目即可。

build.gradle

@@ -0,0 +1,56 @@
+plugins {
+    id 'java'
+    id "com.github.node-gradle.node" version "7.0.2"
+    id "io.freefair.lombok" version "8.0.1"
+    id "run.halo.plugin.devtools" version "0.2.0"
+}
+
+group 'run.halo.starter'
+sourceCompatibility = JavaVersion.VERSION_17
+
+repositories {
+    mavenCentral()
+    maven { url 'https://s01.oss.sonatype.org/content/repositories/releases' }
+    maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' }
+    maven { url 'https://repo.spring.io/milestone' }
+}
+
+dependencies {
+    implementation platform('run.halo.tools.platform:plugin:2.20.0-SNAPSHOT')
+    compileOnly 'run.halo.app:api'
+
+    testImplementation 'run.halo.app:api'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+}
+
+test {
+    useJUnitPlatform()
+}
+
+tasks.withType(JavaCompile).configureEach {
+    options.encoding = "UTF-8"
+}
+
+node {
+    nodeProjectDir = file("${project.projectDir}/ui")
+}
+
+tasks.register('buildFrontend', PnpmTask) {
+    args = ['build']
+    dependsOn('installDepsForUI')
+}
+
+tasks.register('installDepsForUI', PnpmTask) {
+    args = ['install']
+}
+
+build {
+    // build frontend before build
+    tasks.named('compileJava').configure {
+        dependsOn('buildFrontend')
+    }
+}
+
+halo {
+    version = '2.20'
+}

gradle.properties

@@ -0,0 +1 @@
+version=1.0.0-SNAPSHOT

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
+networkTimeout=10000
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists