PHPackages                             n270/nslim4-skeleton - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. n270/nslim4-skeleton

ActiveProject[Framework](/categories/framework)

n270/nslim4-skeleton
====================

A lightweight Slim 4 skeleton with Twig, PHP-DI, Dotenv.

00CSS

Since Feb 8Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/frank270/nPhpSlim4Skeleton)[ Packagist](https://packagist.org/packages/n270/nslim4-skeleton)[ RSS](/packages/n270-nslim4-skeleton/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (3)Used By (0)

Slim 4 Skeleton with Twig & Doctrine DBAL
=============================================

[](#slim-4-skeleton-with-twig--doctrine-dbal)

A lightweight Slim 4 project skeleton with Twig templating, PHP-DI container, Doctrine DBAL, and Dotenv support.

**Perfect for building fast, clean, and flexible PHP applications.**

---

Features
--------

[](#features)

- 🛠️ Slim 4 (Minimal and fast)
- 🎨 Twig 3 Template Engine
- 📦 PHP-DI (Dependency Injection Container)
- 🗄️ Doctrine DBAL (Database Abstraction Layer)
- 🔐 Dotenv (.env configuration support)
- 🛎️ Slim Flash Message (Session flash message)
- 📝 Monolog (Logging)
- 🎯 PSR-7 HTTP Messages (via slim/psr7)

---

Installation
------------

[](#installation)

```
composer create-project youraccount/your-slim4-skeleton project-name
```

Or clone the repository:

```
git clone https://github.com/youraccount/your-slim4-skeleton.git
cd your-slim4-skeleton
composer install
```

---

Project Structure
-----------------

[](#project-structure)

```
app/
  Actions/      → 控制器類別，處理 HTTP 請求
    BaseAction.php      → 基礎控制器類別
    HomeAction.php      → 首頁控制器
    PostDemoAction.php  → 文章示範控制器
    Opanel/             → 後台管理相關控制器
  Middleware/    → 中介層類別
    AdminLogMiddleware.php → 後台操作日誌中介層
    PermissionMiddleware.php → 權限檢查中介層
  Models/        → 資料模型類別
    AdminUsersModel.php → 後台使用者模型
    PostModel.php       → 文章模型
  Routes/        → 路由定義檔案
    home.php            → 首頁路由
    opanel_access.php   → 後台權限管理路由
    opanel_auth.php     → 後台認證路由
    opanel_dashboard.php → 後台儀表板路由
    opanel_users.php    → 後台使用者管理路由
    posts.php           → 文章路由
  Templates/     → Twig 模板檔案
    hello.twig          → 歡迎頁模板
    landing.twig        → 首頁模板
    posts.twig          → 文章列表模板
    opanel/             → 後台模板目錄
  Utils/         → 工具類別
    CustomJsonFormatter.php → JSON 格式化工具
    GptUtils.php        → GPT 相關工具
    LogUtil.php         → 日誌工具
    PermissionChecker.php → 權限檢查工具
  database.php   → 資料庫連線設定 (Doctrine DBAL)
  dependencies.php → 容器依賴設定
  middleware.php → 全域中介層設定
  routes.php     → 路由聚合
  settings.php   → 應用程式設定

cache/
  twig/         → Twig 模板快取

docker/
  mysql/        → MySQL 相關配置
    conf.d/     → MySQL 自定義配置
    init.sql    → 初始化資料庫腳本
  nginx/        → Nginx 相關配置
    app.conf    → 應用程式 Nginx 配置
    phpmyadmin.conf → PHPMyAdmin Nginx 配置
    logs/       → Nginx 日誌目錄
  php/          → PHP 相關配置
    php.ini     → PHP 自定義配置
  phpmyadmin/   → PHPMyAdmin 安裝目錄
  ssl/          → SSL 憑證目錄
  promtail-config.yml → Promtail 日誌收集配置

docs/
  sql/          → SQL 資料庫結構檔案
    add_deleted_at_to_admin_users.sql → 使用者軟刪除欄位
    add_status_to_admin_users.sql     → 使用者狀態欄位
    auth_table.sql                    → 權限管理相關資料表

logs/            → 應用程式日誌目錄
  access.log     → 訪問日誌
  admin_operation-*.log → 後台操作日誌 (依日期分割)
  app.log        → 應用程式日誌
  error.log      → 錯誤日誌
  nginx_*.log    → Nginx 相關日誌
  php-error.log  → PHP 錯誤日誌

public/
  index.php     → 應用程式入口點
  assets/       → 前端靜態資源 (生產環境用，包含編譯後的 Tabler: assets/tabler)
  js/           → JavaScript 檔案
  tabler-dev/   → Tabler 原始碼 (僅供開發參考，已加入 .gitignore)

resources/       → 前端資源原始檔
  react-opanel/ → React 後台應用
  tabler/       → Tabler 原始碼 (供前端編譯引用)

vendor/         → Composer 依賴套件

```

---

Environment Configuration
-------------------------

[](#environment-configuration)

Copy `.env.example` and create your own `.env` file:

```
cp .env.example .env
```

Set your environment variables:

```
APP_ENV=local
APP_DEBUG=true

DB_CONNECTION=pdo_mysql
DB_HOST=127.0.0.1
DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password
```

---

Docker 開發環境
-----------

[](#docker-開發環境)

本專案支援 Docker 開發環境，包含 PHP 8.3、Nginx、MySQL、PHPMyAdmin 和 Redis。

### 前置需求

[](#前置需求)

- Docker
- Docker Compose
- mkcert (用於生成本地信任的 SSL 憑證)
- 在本機 hosts 檔案中加入以下設定： ```
    127.0.0.1 ndev.local
    127.0.0.1 ndba.local

    ```

### 安裝 mkcert

[](#安裝-mkcert)

```
# macOS 使用 Homebrew 安裝
brew install mkcert
brew install nss  # 如果使用 Firefox

# 安裝本地 CA
mkcert -install
```

### 生成 SSL 憑證

[](#生成-ssl-憑證)

```
# 確保 SSL 目錄存在
mkdir -p ./docker/ssl

# 生成 ndev.local 的憑證
mkcert -key-file ./docker/ssl/ndev.local.key -cert-file ./docker/ssl/ndev.local.crt ndev.local "*.ndev.local"

# 生成 ndba.local 的憑證
mkcert -key-file ./docker/ssl/ndba.local.key -cert-file ./docker/ssl/ndba.local.crt ndba.local "*.ndba.local"
```

### 設定環境變數

[](#設定環境變數)

```
# 複製環境變數檔案
cp .env.example .env
```

編輯 `.env` 檔案，設定資料庫連線資訊：

```
APP_ENV=local
APP_DEBUG=true

DB_CONNECTION=pdo_mysql
DB_HOST=mysql
DB_DATABASE=demo_db
DB_USERNAME=your_username
DB_PASSWORD=your_password

REDIS_HOST=redis
REDIS_PORT=6379
```

### 啟動 Docker 環境

[](#啟動-docker-環境)

```
# 啟動 Docker 容器
docker compose up -d
```

### 存取服務

[](#存取服務)

- 網站：
- PHPMyAdmin： (使用本地下載的 PHPMyAdmin)
- MySQL：
    - 主機：mysql
    - 連接埠：3306
    - 資料庫：demo\_db
    - 使用者：如 .env 檔案中設定
- Redis：
    - 主機：redis
    - 連接埠：6379

### 資料庫字元編碼設定

[](#資料庫字元編碼設定)

本專案已設定 MySQL 使用 utf8mb4 字元編碼和 utf8mb4\_general\_ci 排序規則，確保正確處理中文和其他多字節字元。相關設定在：

- `docker-compose.yml` 中的 MySQL 服務環境變數
- `docker/mysql/conf.d/charset.cnf` 中的 MySQL 配置
- `docker/mysql/init.sql` 中的資料表定義

### 停止和重置 Docker 環境

[](#停止和重置-docker-環境)

```
# 停止容器
docker compose down

# 停止容器並移除卷存儲 (重置資料庫和 Redis 資料)
docker compose down -v
```

---

Basic Usage
-----------

[](#basic-usage)

### Define a Route

[](#define-a-route)

In `app/routes.php`:

```
$app->get('/hello/{name}', App\HomeAction::class);
```

### Create an Action

[](#create-an-action)

In `app/src/HomeAction.php`:

```
public function __invoke(Request $request, Response $response, array $args): Response
{
    $name = $args['name'] ?? 'Guest';
    return $this->view->render($response, 'hello.twig', ['name' => $name]);
}
```

### Create a Twig Template

[](#create-a-twig-template)

In `app/templates/hello.twig`:

```
Hello, {{ name }}!
```

---

Requirements
------------

[](#requirements)

- PHP 8.0+
- Composer
- Web Server (Apache / Nginx)

---

License
-------

[](#license)

This project is open-sourced under the [MIT license](LICENSE).

---

更新新聞
----

[](#更新新聞)

### 2026-02-03

[](#2026-02-03)

- 完成聯絡我們模組前台功能,包含表單提交與 Email 通知
- 完成門市據點前台頁面與 API,支援縣市篩選與門市查詢
- 完成品牌歷程模組,使用 CMS Posts 管理時間軸事件
- 完成 CMS 內容區塊 HTML 原始碼編輯模式
- 建立完整的專案文件,包含專案完成總結、資料庫結構概覽、API 端點總覽、部署指南與下一階段規劃

### 2025-12-17

[](#2025-12-17)

- 完成加盟合作模組,包含前台表單提交與後台管理功能
- 實作 Email 通知功能,支援 SMTP 發送
- 整合 SweetAlert2 提供更好的使用者回饋

### 2025-12-16

[](#2025-12-16)

- 完成食品安全檢驗模組,包含前後台完整功能
- 實作 PDF 檔案上傳與下載功能
- 建立檢驗分類與報告管理系統

### 2025-12-15

[](#2025-12-15)

- 完成菜單模組後台功能,包含分類與商品管理
- 實作商品價格管理、標籤系統與 Best Seller 標記
- 支援商品狀態管理 (draft/published/archived)

### 2025-11-19

[](#2025-11-19)

- 完成門市據點模組後台功能
- 實作台灣郵遞區號三層聯動地址選擇器
- 完成 FAQ 模組後台功能,支援分類與問題管理
- 實作精選標記與排序功能

### 2025-11-14

[](#2025-11-14)

- 完成媒體資源庫模組,支援 128 MB 大檔案上傳
- 實作上傳進度條與圖片預覽功能
- 完成外部連結管理模組
- 完成 CMS 內容區塊模組,整合 Quill 富文本編輯器

### 2025-04-28

[](#2025-04-28)

- 新增 CMS 內容管理系統功能
- 實作 CMS 分類管理功能，支援分類的新增、編輯、刪除和排序
- 建立 CMS 內容模型，支援文章和區塊兩種內容類型
- 實作標籤管理功能，支援標籤的搜尋、新增和與內容關聯
- 使用 React 實作分類管理前端介面，提供更流暢的使用體驗
- 建立 CMS 資料庫結構，包含內容、內容類型、分類和標籤相關資料表
- 改進 Action 類別結構，從 BaseAction 繼承並使用容器獲取相依服務

### 2025-04-25

[](#2025-04-25)

- 新增後台使用者管理功能，包含列表、新增、編輯、重設密碼、啟用/停用、刪除等操作
- 使用 React 18 + Vite 實作前端介面，支援 API 模式與傳統表單提交
- 後台操作日誌自動記錄為標準 JSON 格式，符合 SIEM 規範
- 整合 Loki+Grafana 日誌監控，確保日誌保留 90 天
- 後台選單整合，新增使用者管理選項
- UI/UX 改進：採用 Tabler UI 樣式，統一 Toast 通知，操作按鈕均有 SVG 圖標與提示!

### 2025-04-21

[](#2025-04-21)

- 新增 Docker 開發環境支援，包含 PHP 8.3、Nginx、MySQL、PHPMyAdmin 和 Redis
- 加入本地 SSL 憑證生成功能
- 資料庫套件變更：從 Eloquent ORM 改為使用 Doctrine DBAL
- 環境變數處理方式變更：從 `getenv()` 改為使用 `$_ENV`
- 資料庫連線驅動變更：在 .env 檔案中將 `DB_CONNECTION` 從 `mysql` 改為 `pdo_mysql`
- 改進依賴注入方式：在 Action 類別中使用容器獲取服務，而非直接注入
- 在 BaseAction 中增加 `protected ContainerInterface $container` 屬性
- 簡化 PostDemoAction 的錯誤處理邏輯

### 2025-04-07

[](#2025-04-07)

- 初始版本發布
- 完成基本功能設置

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance62

Regular maintenance activity

Popularity0

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity15

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/3a50ca1f9ab49b5562215b32273b1679931267a2eec6a7084a02bd9b7bc06d6e?d=identicon)[n270](/maintainers/n270)

---

Top Contributors

[![frank270](https://avatars.githubusercontent.com/u/1079538?v=4)](https://github.com/frank270 "frank270 (93 commits)")

### Embed Badge

![Health badge](/badges/n270-nslim4-skeleton/health.svg)

```
[![Health](https://phpackages.com/badges/n270-nslim4-skeleton/health.svg)](https://phpackages.com/packages/n270-nslim4-skeleton)
```

###  Alternatives

[laravel/telescope

An elegant debug assistant for the Laravel framework.

5.2k67.8M190](/packages/laravel-telescope)[spiral/roadrunner

RoadRunner: High-performance PHP application server and process manager written in Go and powered with plugins

8.4k12.2M84](/packages/spiral-roadrunner)[nolimits4web/swiper

Most modern mobile touch slider and framework with hardware accelerated transitions

41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M255](/packages/laravel-dusk)[laravel/prompts

Add beautiful and user-friendly forms to your command-line applications.

708181.8M591](/packages/laravel-prompts)[cakephp/chronos

A simple API extension for DateTime.

1.4k47.7M120](/packages/cakephp-chronos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)