Riml Me

🚀 riml - me 項目文檔

這是一個藉助 Next.js App Router 構建的現代化網絡應用程序項目，能高效構建出功能豐富、響應迅速的前端頁面。

🚀 快速開始

首先，啟動開發服務器：

npm run dev
# 或者
yarn dev
# 或者
pnpm dev
# 或者
bun dev

在瀏覽器中打開 http://localhost:3000 即可查看結果。

你可以通過編輯 app/page.tsx 文件來開始修改頁面，編輯時頁面會自動更新。

該項目使用了 next/font，以自動優化並加載 Geist，這是一種適用於網絡的字體。

✨ 主要特性

• 採用 Next.js 15.2 的 App Router 構建前端應用，具備高效的路由管理能力。
• 結合 React v19 框架，提供強大的組件化開發體驗。
• 運用 Tailwind CSS 3.4.4 實現靈活的樣式設計。
• 引入 TypeScript 5.5.4 增強代碼的類型安全。

📦 安裝指南

前提條件

• Node.js 20.18.0
• pnpm 20.1.2

安裝步驟

# 克隆代碼庫
git clone https://github.com/xxxxx/riml-me.git
cd riml-me

# 安裝依賴項
pnpm install

啟動開發服務器

# 啟動開發服務器
pnpm dev

應用程序將在 http://localhost:3000 上運行。

執行測試

# 運行單元測試
pnpm test

# 查看測試覆蓋率
pnpm test:coverage

代碼檢查與格式化

# 執行代碼檢查
pnpm lint

# 執行代碼格式化
pnpm format

📚 詳細文檔

項目結構

/
├── apps/                     # 應用程序代碼
│   └── app/                  # 主應用程序
│       ├── src/             # 源代碼
│       │   ├── app/        # Next.js App Router
│       │   └── components/  # 公共組件
│       ├── public/          # 靜態文件
│       └── ...
├── packages/                 # 共享包
│   ├── biome-config         # Biome 的配置
│   ├── eslint-config        # ESLint 的配置
│   └── vitest-config        # Vitest 的配置
└── ... (配置文件等)

開發規範

• 組件放置在 src/components 目錄下
• 頁面放置在 src/app 目錄下
• 類型定義在各自文件中管理
• 測試文件使用 .test.ts 或 .test.tsx 作為擴展名

🔧 技術細節

技術棧

📄 許可證

本項目基於 MIT 許可證發佈。

💡 使用建議

開發過程中，遵循開發規範能有效提高代碼的可維護性和團隊協作效率。同時，定期執行代碼檢查和格式化，確保代碼質量。