README

网站 🚀 contributte.org | 联系 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte

目标

主要目标是提供最佳准备的入门级项目，适用于 Nette 开发者。

关注点

• PHP 8.1+
• nette/* 软件包
• 通过 nettrine/* 使用 Doctrine ORM
• 通过 contributte/* 使用 Symfony 组件
• 通过 CodeSniffer 和 contributte/qa 进行代码风格检查
• 通过 phpstan 和 contributte/phpstan 进行静态分析
• 通过 Nette Tester 和 contributte/tester 进行单元/集成测试

演示

https://examples.contributte.org/webapp-skeleton/

安装

要安装最新版本的 contributte/webapp-skeleton，请使用 Composer。

composer create-project -s dev contributte/webapp-skeleton acme

使用 docker 安装

1. 首先，使用 Composer 安装此项目。

   composer create-project -s dev contributte/webapp-skeleton
   

2. 之后，您必须设置 Postgres >= 10 数据库。您可以手动启动它或使用 docker 镜像 dockette/postgres:12。

   docker run -it -p 5432:5432 -e POSTGRES_PASSWORD=webapp -e POSTGRES_USER=webapp dockette/postgres:12
   

   或者使用 make 任务，make docker-postgres。

3. 自定义配置文件位于 config/local.neon。如果您想编辑它，请编辑它。

   默认配置应如下所示

   # Host Config
   parameters:
       # Database
       database:
           host: localhost
           dbname: webapp
           user: webapp
           password: webapp

4. 现在数据库正在运行，并且应用程序已配置为连接到它。让我们创建初始数据。

   运行 NETTE_DEBUG=1 bin/console migrations:migrate 创建表。运行 NETTE_DEBUG=1 bin/console doctrine:fixtures:load --append 创建第一个用户。

   或者通过任务 make build。

5. 启动您的开发栈或使用 PHP 本地开发服务器。

   您可以通过运行 php -S localhost:8000 -t www 启动 PHP 服务器或使用预制的 make 任务 make dev。

6. 打开 http://localhost 并享受！

   查看以下内容

   • http://localhost:8000.
   • http://localhost:8000/admin (admin@admin.cz / admin)

使用 docker-compose 安装

1. 首先，使用 Composer 安装此项目。

   composer create-project -s dev contributte/webapp-project
   

2. 修改 config/local.neon 并将主机设置为 database

   默认配置应如下所示

   # Host Config
   parameters:
       # Database
       database:
           host: database
           dbname: webapp
           user: webapp
           password: webapp

3. 运行 docker-compose up

4. 打开 http://localhost 并享受！

   查看以下内容

   • http://localhost.
   • http://localhost/admin (admin@admin.cz / admin)

特性

以下是此项目中您可以找到的所有特性的列表。

• PHP 8.0+
• 📦 软件包
  • Nette 3+
  • Contributte
  • Nettrine
• 🌳 结构
  • app
    • config - 配置文件
      • env - 生产/开发/测试环境
      • app - 应用配置
      • ext - 扩展配置
      • local.neon - 本地运行时配置
      • local.neon.dist - 本地配置模板
    • domain - 业务逻辑和领域特定类
    • model - 应用框架
    • modules - 前端/后台模块、演示者和组件
    • resources - 邮件和其他内容的静态内容
    • ui - UI组件和基本类
    • bootstrap.php - Nette 入口点
  • bin - 控制台入口 (bin/console)
  • db - 数据库文件
    • fixtures - PHP 固定值
    • migrations - 迁移文件
  • docs - 文档
  • var
    • log - 运行时和错误日志
    • tmp - 临时文件和缓存
  • tests - 测试引擎和单元/集成测试
  • vendor - Composer 的文件夹
  • www - 公共内容
• ❗ Tracy
  • 酷的错误 500 页面

显著变更

• $user 变量在模板中 已重命名为 $_user

Composer 包

详细查看每个单独的包。👀

• contributte/bootstrap
• contributte/application
• contributte/di
• contributte/cache
• contributte/http
• contributte/forms
• contributte/latte
• contributte/mail
• contributte/security
• contributte/utils
• contributte/tracy
• contributte/console
• contributte/webapp-skeleton
• contributte/event-dispatcher
• contributte/event-dispatcher-extra
• contributte/neonizer
• contributte/mailing
• contributte/monolog

Doctrine

• contributte/doctrine-orm
• contributte/doctrine-dbal
• contributte/doctrine-annotations
• contributte/doctrine-cache
• contributte/doctrine-migrations
• contributte/doctrine-fixtures

开发

• contributte/dev
• ninjify/qa
• ninjify/nunjuck
• phpstan/phpstan
• mockery/mockery
• nelmio/alice

屏幕截图

admin@admin.cz / admin

开发

查看 如何为此包贡献力量。

此包目前由以下作者维护。

请考虑 支持 contributte 开发团队。也要感谢您使用此项目。