twigkit

For Rapid prototyping and static site generation

🎁 Features

Features	Description
Task Runner	Gulp
CSS	SASS
CSS Tools	Autoprefixer, Source Maps, Stylelint
TailwindCSS	Utility First CSS Framework
JS	Webpack, Babel, ESLint
Live Reload	BrowserSync
HTML Templates	Twig.js
Deployment	GitHub Pages

Usage

Requirements

Make sure all dependencies have been installed before moving on:

• yarn or npm
• Node.js >= 8.16.0
• Gulp

Quick start: Installation

Clone this repository and run

• yarn or npm install to install dependencies

Tasks

Task Name	Description	Environment
yarn start or npm run start	Generate a development environment, start the server and watch for changes	Development
yarn watch or npm run watch	Start the server and watch for changes	Development
yarn build or npm run build	Compile production code	Production
yarn deploy or npm run deploy	Compile production code and deploy to GitHub Pages	Production

Structure

|--dist/                   # →  Static version of the website ready to upload (never edit)
|
|--gulpfile.babel.js/      # →  Gulpfile config and tasks
|--node_modules/           # →  Node.js packages (never edit)
|--src/                    # →  Source files
|  |--assets/              # →  Assets
|  |  |--fonts/            # →  Assets: Fonts
|  |  |--img/              # →  Assets: Images
|  |--modules/             # →  Modules: Multi-part components e.g. Navbar (HTML, CSS and JS)
|  |--scripts/             # →  JS
|  |  |--components/       # →  JS: Components
|  |  |--app.js            # →  JS: Main file
|  |--styles/              # →  Styles
|  |  |--main.scss         # →  Styles: Main stylesheet file
|  |--templates/           # →  Site templates (Twig.js)
|  |  |--layouts/          # →  Templates: Layouts
|  |  |--components/       # →  Templates: Components
|  |  |--pages/            # →  Templates: Pages
|--.babelrc                # →  Babel presets
|--.browserslistrc         # →  Browserslist config, browsers that we support
|--.eslintrc               # →  ESLint config
|--.gitignore              # →  Gitignore
|--.stylelintrc            # →  Stylelint config
|--package-lock.json       # →  NPM lock file (never edit)
|--package.json            # →  Node.js dependencies and scripts
|--webpack.config.js       # →  Webpack config
|--yarn.lock               # →  Yarn lock file (never edit)

Copyright and license

Copyright 2018-2019 Ashton Lance under the MIT license.