Skip to content

A minimal twig bootstrap with gulp tasks to initiate a new web project

License

Notifications You must be signed in to change notification settings

joberror/twig-bootstrap

Repository files navigation

Twig Bootstrap 🛩

Get up to speed with a new Twig web development project

Version License: GNU General Public License (GPL) Dev Dependencies Twitter: @iamjoberror

Features

  • Extended Twig template
  • Twig Auto-loader
  • Php Path setup
  • Web structure to compliment
    • Development mode
    • Production mode
  • Gulp task setup for
  • Workbox - Browser cache services.
  • Sass Mixins (not activated) - Family.css, Sass-Mq, KF-Sass, RFS, Brand Colors and custom mixins.
  • Custom Javascript ES6 modules.

Requirements

  • Node
  • PHP + Composer
  • Any of VS Code, PhpStorm, Atom, Sublime, etc.

Installation

//shell command

> git clone https://github.com/joberror/twig-bootstrap.git

> cd twig-bootstrap

> npm install

> composer install

Getting started

  • Search for all TODO comments in project files and follow the guidelines
  • Folders
    • templates includes twig templates.
    • vendor will include Twig and other packages after composer install is initiated.
    • node_modules will include all Node packages defined in package.json after npm install is initiated.
    • assets-dev is the Development asset folder which will include all assets.
    • assets-prod is where all processed assets files will be stored and ready for production.
    • includes is the default php include folder. Twig and path setup are located here.
  • Run gulp task from terminal using gulp in project root directory while in Dev mode
  • Inline comments are available as a guide in each file.

Author

Show your support

Give a ⭐️ if this project helped you!