/base-project-template

Base assets for starting sites

Primary LanguageCSS

Base Project Template

Built with gulp License Version 1.13.0

Install

There are a few setup commands that need to be run to fully be able to use the assets provided. These files are meant to be used with a Laravel 5.1+ install, but can be adapted for use outside that framework.

Project Setup

Provided npm, yarn, and gulp and are installed globally, create a package.json for dependency management.

npm init

Front End Assets and Build system

yarn add --dev bootstrap-sass bourbon font-awesome gulp html5-boilerplate include-media jquery laravel-elixir laravel-elixir-browserify-official laravel-elixir-vue-2 laravel-elixir-webpack-official lodash normalize.css normalize-opentype.css sassdoc vue

Optional Plugins

yarn add --dev gulp-eslint gulp-postcss postcss-reporter postcss-scss stylelint sweetalert2

Composer

There are 2 sets of composer require commands, one to install production dependencies and the other for dev-only dependencies

composer require anlutro/l4-settings laracasts/utilities jenssegers/agent illuminate/html

Laravel Settings - persistent settings in Laravel
PHP Vars to JS - Simplies passing php vars to js
Laravel Agent - A user agent class for Laravel, based on Mobile Detect with extended functionality.
Laravel Flash - easy flash notifications (not needed anymore)

composer require --dev laracasts/generators barryvdh/laravel-debugbar fzaninotto/faker

Laracasts Generators - additional generators for Laravel 5
Laravel Debugbar - Integrates PHP Debug Bar with Laravel 5
Faker - Dummy data generator
Way Generators - Artisan commands for generating various assets - Laravel 4

Most of the Laravel packages need to have a ServiceProvider and sometimes an Alias added to the main config, and some also require publishing of assets.

ServiceProviders

Add the following to config/app.php

anlutro\LaravelSettings\ServiceProvider::class,
Laracasts\Utilities\JavaScript\JavascriptServiceProvider::class,
Laracasts\Flash\FlashServiceProvider::class,
Jenssegers\Agent\AgentServiceProvider::class,
Barryvdh\Debugbar\ServiceProvider::class,
Laracasts\Generators\GeneratorsServiceProvider::class,
Illuminate\Html\HtmlServiceProvider::class,

Facades / Aliases

Add the following aliases to the array in config/app.php

'Setting'   => anlutro\LaravelSettings\Facade::class,
'Debugbar'  => Barryvdh\Debugbar\Facade::class,
'Flash'     => Laracasts\Flash\Flash::class,
'Agent'     => Jenssegers\Agent\Facades\Agent::class,
'Form'      => Illuminate\Html\FormFacade::class, 
'HTML'      => Illuminate\Html\HtmlFacade::class,

Publish Assets

Publish any assets or config files using php artisan vendor:publish

Misc

Typecsset v0.3.0 - located in resources/assets/sass/base

Sassdoc

Sassdoc generated documentation is located at docs/sass. These files use settings from package.json to apply project specific naming and other data to the compiled docs.

Docs

All docs files are located in resources/assets/docs/. There can be any number of files and sub-folders, and can set in a custom order by pre-pending numbers to the filename, 00_Index.md. Docs are written using markdown and are converted into static html files.

Gulp Commands

Future Updates

  • Add admin components