Chopstick boilerplate
HTML CSS JavaScript Ruby Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_artwork
_gulp
_includes
_layouts
img
js
scss
.editorconfig
.gitignore
.nvmrc
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE.md
README.md
_config.yml
apple-touch-icon-precomposed.png
bower.json
favicon.ico
favicon.png
grid.html
gulpfile.js
index.html
install.sh
lint.yml
package.json
styleguide.html

README.md

Chopstick Boilerplate

By these people

Chopstick Boilerplate creates a structure and gives you the tools that allow you to easily design bespoke web projects.

Chopstick Boilerplate makes use of the Chopstick SCSS framework. It adds tools like Jekyll and Gulp to simplify designing and building in the browser. The boilerplate can be used as a styleguide, to build static websites or to speed up making HTML prototypes.

Need help?

Installation

Requirements

  1. Ruby and rubygems
  2. Node and npm

Automated Installation

Run the following command from the project root:

sh install.sh

This will check if package managers are installed and download required packages for you. If you prefer to install manually, please see manual installation.

Use

Run the following command to load a browsersync server and watch your your files for changes:

gulp watch

More gulp commands are available

SCSS structure.

Project specific code should be written in the components layer. The Chopstick SCSS is maintained in separate repositories which are loaded with npm. We believe these partials should be easy to update and configurable without writing new code.

Read more about partials

Browser support

Chopstick aims to support all modern browsers. This includes latest versions of Chrome, Firefox and Safari and the latest mobile browsers on Android, iPhone and Windows Phone. Internet explorer is currently supported starting from IE10 and up.

Why we make Chopstick framework

  • Maintain sensible defaults
  • Enforce a global coding style
  • Create a scalable system for both small and big web projects

Contributions

You are free to contribute to Chopstick via GitHub Pull Requests. We have a couple of simple guidelines we try to follow, of which most are taken from the CSS Tricks Sass Style Guide. Please refer to the CONTRIBUTING.md for more information