README

inception

A lightweight PHP based web framework built by Snaju Development
<br />
<a href="https://docs.dev.snaju.com/inception"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://git.hou.snaju.com/snaju-oss/inception/issues">Report Bug</a>
·
<a href="https://git.hou.snaju.com/snaju-oss/inception/issues">Request Feature</a>

关于本项目

入门

要获取本地副本并运行，请按照以下简单步骤操作。

先决条件

1. PHP ^7.4|^8.0
2. NodeJS ^14.16

安装

1. 克隆仓库

   git clone https://git.hou.snaju.com/snaju-oss/inception-framework.git
   

2. 安装node依赖

   npm install
   

3. 安装composer依赖

   composer install
   

4. 将.env-example移动到.env并创建数据库并更新详情
5. 如果使用除了8888以外的端口作为PHP服务器，请更新gulpfile.js的第29行，使用正确的端口

用法

• 对于开发，您可以使用npm脚本之一。 npm run start将启动一个开发服务器，该服务器注入js/css以进行实时重新加载，并在模板更新时刷新。注意：如果使用PHPStorm等IDE，文件系统更新将被延迟，这意味着重新加载不会在IDE失去焦点之前触发。

• 如果使用除了8888以外的端口作为PHP服务器，请更新gulpfile.js的第29行，使用正确的端口

// TODO

有关更多示例，请参阅文档

路线图

• [X] 基于文件的路由系统
• [X] Twig渲染
• [X] 全局和路由中间件
• [X] 路由事件（开始、处理、结束、后备）
• [X] 基本响应处理（视图、JSON）
• [X] 请求验证器
• [X] 异常处理
• [X] 全局函数
• [] 插件
• [] 自动API适配器和响应

请参阅开放问题以获取建议功能（和已知问题）列表。

贡献

贡献使开源社区成为一个如此令人惊叹的学习、灵感和创造的地方。您所做出的任何贡献都强烈受到赞赏。

1. 分支项目
2. 创建您的功能分支（git checkout -b feature/AmazingFeature）
3. 提交您的更改（git commit -m 'Add some AmazingFeature'）
4. 推送到分支（git push origin feature/AmazingFeature）
5. 打开一个拉取请求

许可证

在MIT许可证下分发。有关更多信息，请参阅LICENSE。

联系方式

Snaju Development - @snajullc - dev@snaju.com

项目链接：https://git.hou.snaju.com/snaju-oss/inception

致谢

• PHP dotenv - .env文件读取器
• Doctrine ORM快速参考
• phpDocumentor - 从代码生成文档