Proteus

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

Kits

• Middleman
• Jekyll
• Have a request for another kit? Open an issue to let us know.

Installation

1. Install the Proteus gem using the RubyGems package manager:

  gem install proteus-kits

1. Then kick off a new project with the kit you want to use (i.e. Middleman):

  proteus new middleman your-project-name

Shortcuts

We’ve also included some handy shortcuts with Proteus:

• Install dependencies and clear the Git remote:

  proteus setup

• Start the kit-specific server (i.e. bundle exec middleman server):

  proteus server

• Run the kit-specific deploy (i.e. middleman deploy):

  proteus deploy

Contributing

If you'd like to contribute a feature or bugfix: Thanks! To make sure your fix/feature has a high chance of being included, please read the following guidelines:

1. Fork the repository
2. Make your changes
3. Push your branch to your fork
4. Post a pull request.

Please see CONTRIBUTING.md for more details on contributing and running test.

Thank you to all the contributors!

Credits

Proteus is maintained and funded by thoughtbot, inc. Thank you to all of the contributors!

License

Copyright © 2014–2016 thoughtbot, inc. Proteus is free software, and may be redistributed under the terms specified in the license.