Undergarments for your project.
Briefs is a Yeoman generator to get you building interfaces faster.
Some base styles (inspired by Thoughtbot's Bitters) are included to get you up and running quickly.
Jekyll is included for static site generation.
Grunt is used for compilation of Sass and CoffeeScript (optional). Bower is used for managing dependencies.
Choose to include Thoughtbot's mixin libraries Bourbon and/or Neat and, if desired, a UI Framework.
Briefs currently supports Bootstrap, Foundation, and Materialize.
If you do not have Node.js >=0.12, Yeoman >=1.4.5, Ruby >=1.9 and the Bundler gem installed, you must do that first:
npm install -g generator-briefsIf you already have generator-briefs installed, please upgrade before generating another site to get the latest updates.
npm list -g | grep 'generator-briefs' # See your installed version
npm info generator-briefs | grep 'latest' # See latest generator-briefs version
npm update -g generator-briefs # Upgrade generator-briefs globallyBriefs will run bundle install, so if you would like to install the Briefs gems into a gemset, set that up before running yo briefs.
mkdir project-name && cd project-name
yo briefsShould you run into an error such as command yo not found it may be related to a path issue when installing Node.js via Homebrew. Please refer to the top answer on this StackOverflow question.
Serve your source locally into your browser. LiveReload will automatically load any changes to HTML, CSS and JavaScript that you make.
Check the quality of your source with tools like JSLint, CSSLint and csscss.
Build the concatenated, minified production version of the source into the dist directory.
Deploy the production version of the source to GitHub Pages. This ability is configurable during Briefs generation.
If you choose to utilize grunt-build-control to deploy a GitHub Pages user/organization site, your source must live in a branch other than master. GitHub Pages user/organization sites serve the files found in the master branch to the browser.