cbracco / rapid-website-boilerplate

A barebones front-end boilerplate for rapid website prototyping in the browser using Gulp, Nunjucks, PostCSS, Browserify, Browsersync, svg-sprite, and more.

rapid-website-boilerplate

A basic front-end boilerplate for rapid website prototyping in the browser using Gulp, Nunjucks, PostCSS, Browserify, Browsersync, svg-sprite and more.

This tool is a front-end website boilerplate that makes it easier to begin designing and developing rapid website prototypes in the browser. It is a barebones static site generator that automates a few common development tasks and includes a few convenience features so you can focus more on creating a design and less on optimizing a workflow.

• Features
• Requirements
• Installation
• Usage
• Credits
• Contributing
• Changelog
• License

Features

• Gulp 4 as a build system to automate tasks and watch files for changes.
• Nunjucks as a front-end templating language.
• PostCSS for CSS file imports, url rebasing, future-friendly syntax, vendor prefixing, browser & console error reporting, and more.
• Browserify for requiring JavaScript modules and bundling dependencies in the browser.
• Browsersync with xip.io for serving files, live-reloading browsers, and multi-device testing.
• svg-sprite to automatically generate and optimize an SVG sprite from raw SVG files.

Requirements

This project is compatible with Linux, Unix, and Mac OSX operating systems. It requires the following software to be already installed on your system:

• [Node.js][node] (>= 8.11.3)
• [npm][npm] (>= 5.0.0)

Installation

Clone this repository to your local machine, and install its dependencies with the following command(s):

git clone [e-mail]:cbracco/rapid-website-boilerplate.git
cd rapid-website-boilerplate/
npm install

Usage

To start working, first run the following command(s):

npm start

This will run the default Gulp task which builds the website templates and assets, starts a local server with Browsersync, opens the project in your default browser, and begins watching for file changes.

Credits

“If I have seen further it is by standing on ye sholders of Giants.” — Issac Newton

rapid-website-boilerplate is a project by @cbracco and its contributors. It is influenced by the following organizations, projects, articles, and individuals:

• gulp-tutorial by @kogakure
• tape-standard by @rstacruz
• How to Modularize HTML Using Template Engines and Gulp by @zellwk

Thank you all for your hard work.

Contributing

Changelog

License