README

Sikessem Starter

使用 PHP 和 Laravel 预配置 TypeScript、Livewire、Alpine.js、TailwindCSS 以及其他如 Bun、Vite.js、Biome、Pint、PHPStan、Larastan、Rector 等工具快速开始应用程序开发。

🔖 内容

Sikessem Starter

🎉 入门指南

⚡️ 安装

使用此模板或通过 Composer create-project 命令创建新的 Sikessem 项目（推荐）

composer create-project sikessem/starter my-app

其中 my-app 是您应用程序的名称。

访问工作目录

cd my-app

安装 PHP 依赖

composer install

安装 JS / TS 依赖

bun install

🍱 构建资源文件

生产构建将运行客户端和服务器构建命令来生成客户端和服务器模块

bun run build

🗃️ 管理数据库

安装迁移

php artisan migrate:install && php artisan migrate

🌐 启动服务器

以开发模式运行服务器

php artisan serve --host=my-app.local --port=8000

然后访问 http://my-app.local:8000/

🧪 测试和调试

🧹 保持现代代码库

使用 Biome

bun check

使用 Pint

composer check

⚗️ 运行静态分析

使用 PHPStan

composer analyse

✅ 运行单元测试

使用 Bun

bun run test

使用 PEST

composer test

🚀 使用 Playwright 执行端到端测试

bun e2e

🐛 检查所有代码错误

前端

bun debug

后端

composer debug

📋 要求

需要 PHP 8.2+（至少推荐 8.2.14 以避免潜在的错误）。
需要 Bun 1.0+（至少推荐 1.0.21 以避免潜在的错误）。
需要 Composer >=2.6.6 来管理 PHP 依赖。
需要 Git ~2.42.0 来管理源代码。

📖 文档

Sikessem Starter 的完整文档可以在此地址找到。

👏 贡献

本仓库的主要目的是继续发展 Sikessem。我们希望使对该项目的贡献尽可能容易和透明，并对社区为修复错误和改进做出贡献表示感谢。请向下阅读了解您如何参与改进 Sikessem。

👷 行为准则

Sikessem 采纳了行为准则，我们希望项目参与者遵守。请阅读完整内容，以便了解哪些行为是可以接受的，哪些行为是不被容忍的。

👥 贡献指南

阅读我们的贡献指南，了解我们的开发流程、如何提出错误修复和改进建议，以及如何构建和测试您的 Sikessem 修改。

🔒️ 新手友好问题

我们有一份适合新手的任务列表，其中包含一些范围相对有限的错误。这是一个开始、积累经验和熟悉我们的贡献流程的好地方。

💬 讨论

更大的讨论和提案在Sikessem 的 GitHub 讨论区中进行。

🔐 安全报告

如果您在 Sikessem 中发现安全漏洞，请发送电子邮件至SIGUI Kessé Emmanuel，邮箱地址为 contact@sigui.ci。所有安全漏洞都将得到及时处理。

📄 许可证

Sikessem Starter 是开源软件，采用 MIT 许可协议许可 - 有关详细信息，请参阅 LICENSE 文件。

_{由 @siguici 热心打造。}

my-sikessem / starter

维护者

详细信息