ziperrom1/laravel-boilerplate

添加了前端框架的Laravel框架

dev-master 2016-07-17 19:45 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:20:09 UTC


README

Build Status Total Downloads Latest Stable Version Latest Unstable Version License

Laravel是一个具有表达性和优雅语法的Web应用程序框架。我们相信开发必须是一个愉快、富有创造性的体验,才能真正令人满意。Laravel试图通过简化大多数Web项目中常用的常见任务(如身份验证、路由、会话、队列和缓存)来减轻开发过程中的痛苦。

Laravel易于使用且功能强大,提供了构建大型、健壮应用程序所需的所有工具。出色的依赖注入容器、表达式的迁移系统以及紧密集成的单元测试支持,为您提供了构建任何任务的工具。

官方文档

框架的文档可以在Laravel网站上找到。

入门指南

该项目基于Laravel5框架。添加到初始Laravel结构中的boilerplate由以下列出的几个有用的前端工具组成。

要添加库,将其添加到bower.json文件和public/js/app.config.js => paths中。

然后设置js / sass / fonts所需文件为您的新的外部库,在gulp.babel.js中的paths常量声明L.24

然后运行gulp bower,然后voilà,您的库就准备好了!

所有js供应商文件都导入到public/js/vendors目录中。

所有scss供应商文件都导入到resources/assets/sass/vendors目录中。

所有字体供应商文件都导入到resources/assets/fonts目录中。

注意:要使用es6模块,在您的require|define调用中添加es6!your-es6-module

Gulp集成

Gulp用于自动化任务,使用nodeJs处理文件。

Laravel使用一个名为elixir的工具,它基本上是gulp的包装,用于快速处理基本任务。

我决定覆盖这个工具,并直接使用纯gulp 4实现,具有很好的es6语法,而elixir基于gulp 3。

Gulp任务

  • 供应商bower需求
    • bowerDownload (在bower_components目录中下载bower依赖项)
    • bowerMoveJs (将js供应商文件移动到public/js/vendor目录)
    • bowerMoveSass (将sass供应商文件移动到resources/assets/vendor目录)
    • bowerMoveFonts (将字体供应商文件移动到resources/assets/fonts目录)
    • bowerClean (在js、字体和sass源文件中清理bower依赖项(不在bower_components中))
    • bower (bowerDownload、bowerClean、bowerMoveJs、bowerMoveSass和bowerMoveFonts的包装器)
  • Sass / js构建
    • sassDev (编译sass文件并在生成的.css结果文件中生成map)
    • sassProd (将sass文件编译成.css文件)
    • buildJs (使用requirejs和requirejs优化器将js源文件构建到public/dist/app.js中)
  • 检查器
    • eslint (使用eslint linter检查js文件)
  • jsDoc
    • jsdoc (在storage/app/public/jsDoc中生成jsdoc)

所有依赖必须在L.24的paths常量声明中列出。

Sass

在这里,Sass集成非常简单。使用一个主resources/assets/sass/app.scss文件来引入所有Sass依赖项。

此文件使用Sass预处理器编译,并使用命令gulp sassDevgulp sassProd(不包含源映射)生成所有应用的唯一public/dist/style.css文件。

您可以在resources/assets/sass目录中添加尽可能多的自定义.scss文件,确保将这些文件添加到主resources/assets/sass/app.scss文件中。

Eslint

.eslintrc.json文件中默认设置了eslint:all,可以编辑此文件来添加/删除js检查规则。

Jsdoc

使用命令gulp jsdoc,jsdoc将在storage/app/public/jsDoc目录中自动生成。

使用ink-docstrap主题生成文档。

可以在jsdocConfig.json文件中编辑jsdoc参数。