colymba / silverstripe-project-boilerplate
SilverStripe项目boilerplate/skeleton,包含实用的工具、技巧和窍门。
Requires
This package is auto-updated.
Last update: 2024-09-20 01:59:23 UTC
README
这是一个非常具有个人观点的SilverStripe项目boilerplate/skeleton,包含实用的工具、技巧和窍门。
要求
- SilverStripe 3
- NodeJS
- GruntJS
- Bower
TL;DR
此项目替换了任何SilverStripe安装中默认的mysite
和themes
文件夹,并用一个紧凑的项目目录替换它们,易于管理和分发。
详细信息
一旦SilverStripe启动并运行,保存重要的_config.php
设置,删除mysite
文件夹。将ss-project-boilerplate
文件夹重命名为您有意义的东西,并更新_config.php
。
大多数文件中都有注释,因此请继续阅读以了解更多关于每行代码的信息。此模块将强制以下项目结构
前端依赖
所有前端依赖(CSS + JS)都通过Bower管理,编辑bower.json
以满足您的需求,然后运行bower update
。这些将在稍后自动注入到SileverStripe模板中(Page.ss
+ js.ss
)。
开发和发布您的项目
我们将使用GruntJS来自动化开发和发布过程,因此请确保首先通过运行npm update
安装NodeJS包依赖项。
完成之后,运行grunt dev
并开始编码。这将为您注入Bower JS/CSS/SCSS依赖项,创建自定义的Modernizr,并为您监视和编译SASS。
一旦您完成并准备好发布项目,运行grunt dist
,所有项目文件的优化副本将位于_dist
目录中,准备上传。配置将更新为实时,CSS/JS连接并压缩,以及所有模板也将压缩。
开发/实时配置
grunt dist
任务将自动将您的config.yml
中的environment_type: 'dev'
引用替换为live
。
对于PHP文件(这适用于您项目目录中的所有PHP文件),您可以使用带边框的代码块来指定要删除或启用分发版本中的代码(请参阅_config.php
中的示例)
- 使用
/*::config:dev*/
.../*::config*/
标记要删除的代码块 - 使用
/*::config:live
...::config*/
标记要启用的代码块
许可证(BSD简化版)
版权所有(c)2013,Thierry Francois(colymba)
保留所有权利。
在满足以下条件的情况下,允许重新分发和使用源代码和二进制形式,无论是否修改:
- 源代码重新分发必须保留上述版权声明、本条件列表和以下免责声明。
- 二进制形式的重新分发必须复制上述版权声明、本条件列表和以下免责声明在随分发提供的文档和/或其他材料中。
- 未经事先书面许可,不得使用Thierry Francois或colymba的名称或其贡献者的名称来推广或推广由此软件派生出的产品。
本软件由版权所有者和贡献者提供,“原样”提供,不承担任何明示或暗示的保证,包括但不限于适销性和针对特定目的的适用性保证。在任何情况下,版权所有者或贡献者均不对因使用本软件而引起的任何直接、间接、偶然、特殊、示范性或后果性损害(包括但不限于替代商品或服务的采购;使用、数据或利润的损失;或业务中断)承担责任,无论损害产生的原因如何,无论基于合同、严格责任还是侵权(包括疏忽或其他),即使被告知可能发生此类损害。