Filament Peek 项目使用教程

Filament Peek 项目使用教程

filament-peek Full-screen page preview modal for Filament 项目地址: https://gitcode.com/gh_mirrors/fi/filament-peek

1. 项目目录结构及介绍

Filament Peek 项目是一个为 Filament PHP 框架添加全屏预览功能的插件。以下是项目的目录结构及各部分功能的简要介绍：

filament-peek/
├── .github/                # GitHub 工作流和相关配置文件
├── art/                    # 项目艺术作品和图像
├── config/                 # 配置文件
├── docs/                   # 项目文档
├── resources/              # 资源文件，如视图、样式表等
├── routes/                 # 路由定义文件
├── src/                    # 源代码目录
├── tests/                  # 测试文件目录
├── .editorconfig            # 编辑器配置文件
├── .gitattributes           # Git 属性配置文件
├── .gitignore              # Git 忽略文件
├── .prettierrc             # Prettier 配置文件
├── CHANGELOG.md            # 更改日志文件
├── LICENSE.md              # 许可证文件
├── README.md               # 项目说明文件
├── composer.json           # Composer 配置文件
├── generate-toc.php        # 生成目录结构的 PHP 脚本
├── package-lock.json       # 包版本锁定文件
├── package.json            # npm 包配置文件
├── phpstan-baseline.neon   # PHPStan 基线配置文件
├── phpstan.neon.dist        # PHPStan 配置文件
├── phpunit.xml.dist         # PHPUnit 配置文件
├── postcss.config.js       # PostCSS 配置文件
├── tailwind.config.js      # Tailwind CSS 配置文件

2. 项目的启动文件介绍

项目的启动主要依赖于 Composer 和 PHP 的配置。以下是一些主要的启动文件：

• composer.json: 定义了项目依赖的其他包和库。在项目初始化时，你需要运行 composer install 来安装这些依赖。
• phpunit.xml.dist: PHPUnit 测试配置文件。用于配置和执行单元测试。

3. 项目的配置文件介绍

项目的配置文件主要用于定义和修改插件的行为。以下是一些重要的配置文件：

• .editorconfig: 用于定义项目中的代码风格，如缩进、换行符等。
• .prettierrc: 用于配置 Prettier 的代码格式化规则，确保代码风格的统一。
• config/filament-peek.php: Filament Peek 的主要配置文件，用于定义插件的全局设置。
• tailwind.config.js: Tailwind CSS 的配置文件，用于定制 CSS 样式。

在开始使用 Filament Peek 插件之前，确保你已经阅读了上述文件，并根据你的项目需求进行相应的配置调整。

filament-peek Full-screen page preview modal for Filament 项目地址: https://gitcode.com/gh_mirrors/fi/filament-peek