midnightluke / boot-frames
Requires
- fzaninotto/faker: ^1.8
- symfony/finder: ^4.0
- symfony/http-foundation: ^4.0
- symfony/yaml: ^4.0
- twig/twig: ^2.0
Requires (Dev)
- kint-php/kint: ^3.1
README
Boot Frames 是一个使用 Twig 和 Bootstrap 的框架,为网页开发者提供了一个快速构建网站线框和原型的途径。
为什么存在这个框架?
我是一个每天使用PHP构建网站的後端开发者。有时我需要为客户端/设计师/项目经理等制作线框来解释某个概念,或者在某些情况下,为了更好地理解某个概念,我需要为网站的一部分制作线框。作为一名後端开发者,我发现自己不太喜欢像"My Balsamiq"和"Moqups"这样的工具(这些工具非常适合非技术人员的线框制作),我渴望能够只编写一些HTML,而不用重复那么多次。
随着一些真正出色的模板语言的问世,以及我在Drupal和Symfony方面的经验,我决定创建一个简单的框架,让我能够快速地将一些常见的网站元素组合起来,并使用HTML、CSS和JavaScript快速构建线框,结果是Boot Frames。
Boot Frames 使用Twig作为模板引擎,Bootstrap作为基本主题,让开发者能够以舒适和熟悉的方式快速构建线框(并且大多数情况下,结果会更接近最终效果)。它还提供了一套常见的工具,使项目经理和客户能够轻松地浏览和操作线框。
安装
您可以选择克隆此存储库或从上面的“发布”选项卡下载并解压缩一个版本。从根目录运行
composer install
以安装Boot Frames的依赖项。
要运行bootframes,您需要使web/
目录在网页浏览器中可用,这可以在您的本地以多种方式完成,但在此文档中不进行介绍。在浏览器中访问Boot Frames,您应该就可以使用了。
配置
Boot Frames在config/
目录中有两个文件
config.yml
:此文件包含全局应用程序配置routes.yml
:此文件包含手动配置的路线(这是可选的)
创建线框
默认情况下,Boot Frames将扫描templates/
以查找线框,并自动为找到的任何模板创建路由(这可以在config.yml文件中重写)。
要创建一个新的线框,只需在templates/
目录(或任何子目录)中创建一个新的模板,它将自动出现在线框列表中。
有关使用Twig的帮助,请查看其网站上的优秀文档。
Boot Frame链接助手
Boot Frames附带了一些Twig插件,以便轻松创建线框之间的链接以及链接到web/
目录中的资源。
url
在您的模板中使用{{ url('/absolute/url') }}
来链接到网页目录中的绝对URL,这将为链接添加任何必需的子目录前缀(以下所有函数都通过此函数传递)。
route
使用 {{ route('/route/machine/name') }}
(或使用 routes.yml 文件时,使用 {{ route('route_machine_name') }}
)。用于链接到任何已定义的路由。如果 Boot Frames 找不到路由,它将简单地输出一个 #
,这样您就可以稍后创建线框(如果您愿意的话),链接将自动激活。
route_reverse
这个函数与 route
函数功能相同,但它允许您输入一个路径并获得相同的结果(如果该路径没有为路由定义,则返回一个活动链接或 #
)。当使用 routes.yml 文件时,这更有用。
Boot Frame 认证状态
默认情况下,Boot Frames 设置并维护两个 GET 参数 "authenticated" 和 "privileged",这些被设置为全局 twig 变量,因此所有模板都可以访问它们并相应地修改行为,例如
{% if authenticated %} Only authenticated users can see this. {% else %} You are not authenticated. {% endif %}
导航线框
Boot Frames 提供了几个辅助工具,允许用户清楚地查看线框的所有活动链接,并以 "authenticated" 和 "privileged" 用户查看相同的线框。切换 "authenticated" 和 "privileged" 的控件显示在屏幕的左下角,同时还有一个链接返回线框索引。
在任意页面上按下 q
键将突出显示所有可用的链接,使用 bootstrap 工具提示。默认情况下,工具提示显示链接的 href 属性,但您可以指定一个标题来覆盖此属性。