PART ONE
專案總覽|功能與應用場景
此專案是 WoowHome 應用的後端服務,負責處理核心業務邏輯、資料儲存與 API 接口。它為 WoowHome 前端(可能是行動應用或網頁介面)提供必要的數據支持與功能實現,是整個系統的中樞神經。
🔑 核心功能
- API 接口管理
- 使用者身份驗證
- 資料庫管理
- 業務邏輯處理
- 應用程式後端支持
- 系統配置管理
📋 功能詳細說明
| 功能名稱 | 說明 |
|---|---|
| 使用者註冊與登入 | 行動應用前端呼叫後端提供的 API,讓新使用者可以註冊帳號。已註冊的使用者則可透過登入 API 進行身份驗證,獲取用於後續操作的存取權杖,確保服務的安全性。 |
| 同步家庭設備狀態 | 使用者在 WoowHome 應用中操作智慧家庭設備(如開關燈光)時,前端會發送請求至後端。後端接收指令後,更新資料庫中的設備狀態,並可透過對應的物聯網協議將指令傳達給實體設備,實現狀態的即時同步。 |
PART TWO
深入解析|執行環境與部署步驟
⚙️ 執行環境需求
- 運行此專案所需的軟體、硬體和相依套件
- 建議使用 Ubuntu 22.04 LTS 或其他主流 Linux 發行版。
- 建議至少 2 核心 CPU、4GB RAM 和 20GB 儲存空間,以確保服務穩定運行。
- 需要 Python 3.10 或更高版本。建議使用虛擬環境管理專案相依性。
- 需要 PostgreSQL 14 或更高版本。請確保資料庫服務正常運行,並已建立專用資料庫與使用者。
🔧 部署安裝步驟
| 步驟 | 說明 |
|---|---|
| Step 1 | 在您的伺服器上,使用 \`git clone https://github.com/WOOWTECH/wow_home_backend.git\` 克隆此倉庫。 |
| Step 2 | 進入專案目錄:\`cd wow_home_backend\`。 |
| Step 3 | 建立並啟用 Python 虛擬環境:\`python3 -m venv venv && source venv/bin/activate\`。 |
| Step 4 | 安裝所需的 Python 相依套件:\`pip install -r requirements.txt\`。 |
| Step 5 | 根據 \`config.example.py\` 建立一個 \`config.py\` 檔案,並填寫您的資料庫連線資訊及其他必要設定。 |
| Step 6 | 執行資料庫遷移以建立所需的資料表:\`python manage.py db upgrade\`。 |
| Step 7 | 啟動後端應用程式伺服器:\`gunicorn --bind 0.0.0.0:8000 app:app\`。 |
PART THREE
總結與展望|AI Agent 部署 Prompt
🤖 AI Agent 部署 Prompt
以下是用於部署此專案的 AI Agent Prompt,可直接複製使用:
複製此 Prompt 給 AI Agent,即可自動完成安裝、部署與測試
← 返回開源專案列表