Code Monkey home page Code Monkey logo

chopstick-boilerplate's Introduction

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

chopstick-boilerplate's People

Contributors

xavez avatar adeggermont avatar jonasdegeest avatar dietr avatar jonathandcstr avatar simoncoudeville avatar jessedobbelaere avatar driesstandaert avatar jnnck avatar woutersioen avatar zofie avatar fspin avatar herpoelaertw avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.