Chopstick Boilerplate

Overview:

Chopstick Boilerplate is a web development tool that provides a structure and the necessary tools to easily create custom web projects. It utilizes the Chopstick SCSS framework and includes additional features like Jekyll and Gulp to simplify the design and development process. The boilerplate can be used as a styleguide, for building static websites, or for quickly creating HTML prototypes.

Features:

• Chopstick SCSS Framework: Utilizes the Chopstick SCSS framework to provide a foundation for designing web projects.
• Jekyll and Gulp: Includes Jekyll and Gulp tools to simplify the designing and building process in the browser.
• Styleguide and Prototyping: Can be used as a styleguide or for quickly creating HTML prototypes.

Requirements:

• Ruby and rubygems
• Node and npm

Automated Installation:

1. Run the following command from the project root: sh install.sh
2. This command will check if package managers are installed and download the required packages for you.

Manual Installation:

• Please refer to the manual installation instructions on the project's documentation for more information.

Usage:

1. Run the following command to load a browsersync server and watch your files for changes: <command>
2. Additional gulp commands are available for different tasks, refer to the project's documentation for more information.

SCSS Structure:

• Project-specific code should be written in the components layer.
• The Chopstick SCSS framework is maintained in separate repositories and can be easily updated and configured without writing new code.

Browser Support:

• Chopstick aims to support all modern browsers, including the latest versions of Chrome, Firefox, and Safari, as well as the latest mobile browsers on Android, iPhone, and Windows Phone.
• Internet Explorer is supported starting from IE10 and up.

Summary:

Chopstick Boilerplate is a web development tool that provides a structure and necessary tools to easily design and build bespoke web projects. With the use of the Chopstick SCSS framework, Jekyll, and Gulp, developers can simplify the development process, create styleguides, build static websites, or create HTML prototypes. The installation process is automated, and the documentation provides guidelines for contributing to the project via GitHub Pull Requests.