This repository has been archived by the owner. It is now read-only.
[no longer maintained]
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
source
.gitignore
Gulpfile.js
README.md
package.json

README.md

Proteus - Gulp

Note: This project is no longer being actively maintained.

About Proteus

Proteus is a collection of useful starter kits to help you prototype faster. It follows the thoughtbot styleguide and includes our favorite front end tools.

Includes

  • Gulp: Converts files and task running
  • HAML: Simple template markup
  • Coffeescript: Write javascript with simpler syntax
  • Sass: CSS with superpowers
  • Bourbon: Sass mixin library
  • Neat: Semantic grid for Sass and Bourbon
  • Bitters: Scaffold styles, variables and structure for Bourbon projects.
  • Express: Lightweight Node web server

We also recommend Refills for prepackaged interface patterns.

Getting Started

Set up your project in your code directory

git clone https://github.com/thoughtbot/proteus-gulp.git your-project-folder
cd your-project-folder
git remote rm origin
git remote add origin your-repo-url

Install the dependencies

npm install

Run the server

gulp

Deploy to Github Pages

gulp deploy

Or install the Proteus gem and enjoy some shortcuts.

Stylesheets, images, fonts, and javascript files go in the /source/assets/ directory. Vendor stylesheets and javascripts should go in each of their /vendor/ directories. The source folders for images and fonts have a .keep file in them so they can be in the repo, but you can remove those files.

Contributing

If you have problems, please create a GitHub Issue

Have a fix or want to add a feature? Open a Pull Request

Credits

thoughtbot

This application is maintained and funded by thoughtbot, inc

Thank you to all the contributors!

License

The names and logos for thoughtbot are trademarks of thoughtbot, inc.

Proteus Gulp is Copyright © 2014 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.