docs: 更新 README.md 專案說明與安裝教學

2025-11-21 17:22:13 +08:00
parent c7cbe7edb7
commit 4c305821eb
1 changed files with 79 additions and 48 deletions
--- a/README.md
+++ b/README.md
@@ -1,66 +1,97 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
+# Star Cloud 智能販賣機管理平台

-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
+## 專案簡介 (Project Description)
+Star Cloud 是一個專為智能販賣機設計的後台管理系統，旨在提供全方位的機台監控、庫存管理、銷售分析與會員管理功能。透過此平台，管理者可以即時掌握機台運營狀態，優化補貨流程，並透過數據分析提升營運效益。

-## About Laravel
+## 技術棧 (Technology Stack)

-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+### 後端 (Backend)
+- **Framework**: Laravel 10.x
+- **Language**: PHP 8.1+
+- **Database**: MySQL 8.0+
+- **Authentication**: Laravel Sanctum (API Token Authentication)
+- **Tools**: Composer

- [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+### 前端 (Frontend)
+- **Framework**: Blade Templates (Laravel 預設樣板引擎)
+- **CSS Framework**: Tailwind CSS 3.x
+- **JavaScript**: Alpine.js 3.x
+- **Build Tool**: Vite 5.x
+- **HTTP Client**: Axios

-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+## 安裝與使用說明 (Installation & Usage)

-## Learning Laravel
+請依照以下步驟將專案 Clone 至本地端並開始運行：

-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+### 1. 下載專案 (Clone Repository)
+```bash
+git clone <repository_url>
+cd star-cloud
+```

-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
+### 2. 安裝依賴套件 (Install Dependencies)

-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+安裝後端 PHP 套件：
+```bash
+composer install
+```

-## Laravel Sponsors
+安裝前端 Node.js 套件：
+```bash
+npm install
+```

-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
+### 3. 環境變數設定 (Environment Setup)
+複製範例環境設定檔：
+```bash
+cp .env.example .env
+```

-### Premium Partners
+請開啟 `.env` 檔案，並依照您的本地環境設定資料庫連線資訊：
+```dotenv
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=star_cloud
+DB_USERNAME=root
+DB_PASSWORD=your_password
+```

- **[Vehikl](https://vehikl.com/)**
- **[Tighten Co.](https://tighten.co)**
- **[WebReinvent](https://webreinvent.com/)**
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
- **[64 Robots](https://64robots.com)**
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
- **[Cyber-Duck](https://cyber-duck.co.uk)**
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
- **[Jump24](https://jump24.co.uk)**
- **[Redberry](https://redberry.international/laravel/)**
- **[Active Logic](https://activelogic.com)**
- **[byte5](https://byte5.de)**
- **[OP.GG](https://op.gg)**
+產生應用程式金鑰 (Application Key)：
+```bash
+php artisan key:generate
+```

-## Contributing
+### 4. 資料庫遷移 (Database Migration)
+執行 Migration 以建立資料庫結構：
+```bash
+php artisan migrate
+```
+*(若專案包含預設資料，可加上 `--seed` 參數)*

-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+### 5. 編譯前端資源 (Build Frontend Assets)
+啟動開發模式 (Hot Module Replacement)：
+```bash
+npm run dev
+```
+或編譯生產環境檔案：
+```bash
+npm run build
+```

-## Code of Conduct
+### 6. 啟動伺服器 (Start Server)
+啟動 Laravel 開發伺服器：
+```bash
+php artisan serve
+```
+預設網址為：http://localhost:8000

-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+## 主要功能模組
+- **儀錶板 (Dashboard)**: 銷售數據概覽、機台狀態監控
+- **機台管理 (Machine Management)**: 機台列表、遠端控制、日誌查詢
+- **商品與庫存 (Inventory)**: 商品管理、進銷存、補貨單
+- **銷售管理 (Sales)**: 交易紀錄、營收報表
+- **權限設定 (Permissions)**: 角色與權限分配

-## Security Vulnerabilities
-
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
-
-## License
-
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+---
+© Star Cloud. All Rights Reserved.