chore : 프로젝트 초기화 (kotlin springboot, vitepress docs)

Author: polyglot-k

.gitattributes

@@ -0,0 +1,3 @@
+/gradlew text eol=lf
+*.bat text eol=crlf
+*.jar binary

.github/workflows/docs-deploy.yml

@@ -0,0 +1,37 @@
+name: Docs Build & Deploy
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: 22
+
+      - name: Install deps
+        run: yarn install --frozen-lockfile
+        working-directory: docs
+
+      - name: Build VitePress site
+        run: yarn run build
+        working-directory: docs
+
+      - name: Install Vercel CLI
+        run: npm install -g vercel
+
+      - name: Deploy to Vercel
+        run: vercel --prod --token=${{ secrets.VERCEL_TOKEN }} --confirm --cwd docs/.vitepress/dist

.gitignore

@@ -0,0 +1,42 @@
+docs/node_modules/
+docs/.vitepress/cache/
+HELP.md
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### Kotlin ###
+.kotlin

build.gradle.kts

@@ -0,0 +1,56 @@
+plugins {
+    kotlin("jvm") version "1.9.25"
+    kotlin("plugin.spring") version "1.9.25"
+    id("org.springframework.boot") version "3.5.6"
+    id("io.spring.dependency-management") version "1.1.7"
+    kotlin("plugin.jpa") version "1.9.25"
+}
+
+group = "com.example"
+version = "0.0.1-SNAPSHOT"
+description = "demo"
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(21)
+    }
+}
+
+configurations {
+    compileOnly {
+        extendsFrom(configurations.annotationProcessor.get())
+    }
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
+    implementation("org.jetbrains.kotlin:kotlin-reflect")
+    compileOnly("org.projectlombok:lombok")
+    runtimeOnly("com.h2database:h2")
+    annotationProcessor("org.projectlombok:lombok")
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+}
+
+kotlin {
+    compilerOptions {
+        freeCompilerArgs.addAll("-Xjsr305=strict")
+    }
+}
+
+allOpen {
+    annotation("jakarta.persistence.Entity")
+    annotation("jakarta.persistence.MappedSuperclass")
+    annotation("jakarta.persistence.Embeddable")
+}
+
+tasks.withType<Test> {
+    useJUnitPlatform()
+}

docs/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

docs/.vitepress/config.mjs

@@ -0,0 +1,16 @@
+import { defineConfig } from 'vitepress'
+import {sidebar} from './sidebar-generator.mjs'
+
+// https://vitepress.vuejs.org/config/app-configs
+export default defineConfig({
+  title: "모잇 BE 문서화",
+  description: "모잇 BE 문서화",
+
+  themeConfig: {
+    sidebar:sidebar,
+    nav: [
+      {text: 'Home', link: '/'},
+      {text: 'API Docs', link: '/api/index.md'}
+    ],
+  }
+})

docs/.vitepress/sidebar-generator.mjs

@@ -0,0 +1,45 @@
+import fs from 'fs';
+import path from 'path';
+
+const docsRoot = path.resolve(__dirname, '..');
+
+/**
+ * 파일 이름을 Title Case 형태의 텍스트로 변환합니다.
+ * e.g., 'error-subscription.md' -> 'Error Subscription'
+ * @param {string} filename - 변환할 파일 이름
+ */
+function toTitleCase(filename) {
+  return filename.replace(/-/g, ' ').replace(/\.md$/, '')
+  .split(' ')
+  .map(word => word.charAt(0).toUpperCase() + word.slice(1))
+  .join(' ');
+}
+
+/**
+ * 지정된 디렉토리 경로에서 사이드바 그룹 객체를 생성합니다.
+ * @param {string} dirPath - 'docs' 기준의 상대 경로 (e.g., 'api/rest')
+ * @param {string} groupText - 사이드바에 표시될 그룹 이름
+ */
+function getSidebarGroup(dirPath, groupText) {
+  const fullPath = path.join(docsRoot, dirPath);
+  try {
+    const files = fs.readdirSync(fullPath);
+
+    const items = files
+    .filter(file => file.endsWith('.md'))
+    .map(file => {
+      const link = `/${dirPath}/${file.replace(/\.md$/, '')}`;
+      return {text: toTitleCase(file), link};
+    });
+
+    return {text: groupText, items};
+  } catch (error) {
+    console.warn(`Could not read directory for sidebar group: ${fullPath}`,
+        error);
+    return {text: groupText, items: []};
+  }
+}
+
+export const sidebar = [
+  getSidebarGroup('api', 'REST APIs'),
+];

docs/api/index.md

@@ -0,0 +1 @@
+# API 명세입니다.

docs/guide.md

@@ -0,0 +1,4 @@
+
+# 가이드
+
+이것은 가이드 페이지입니다.

docs/index.md

@@ -0,0 +1 @@
+# Hello World