contributte/webapp-skeleton

Webapp skeleton 是一个功能齐全的基于 Nette 框架 + Contributte 的 Web 应用程序套件,由 @f3l1x 提供了许多有用的包。


README

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

目标

主要目标是提供为 Nette 开发者准备的最佳入门套件项目。

关注点

  • PHP 8.1+
  • nette/*
  • 通过 nettrine/* 的 Doctrine ORM
  • 通过 contributte/* 的 Symfony 组件
  • 通过 CodeSniffercontributte/qa 进行 codestyle 检查
  • 通过 phpstancontributte/phpstan 进行静态分析
  • 通过 Nette Testercontributte/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. 打开 https:// 并享受吧!

    请参阅

使用 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. 打开 https:// 并享受吧!

    请参阅

功能

以下是您可以在本项目中找到的所有功能的列表。

  • PHP 8.0+
  • 📦 包
    • Nette 3+
    • Contributte
    • Nettrine
  • 🌳 结构
    • app
      • config - 配置文件
        • env - prod/dev/test 环境
        • 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包

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

Doctrine

Dev

截图

admin@admin.cz / admin

开发

查看如何为此包做出贡献

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

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