Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thoughtbot/proteus
[no longer maintained]
https://github.com/thoughtbot/proteus
Last synced: 3 months ago
JSON representation
[no longer maintained]
- Host: GitHub
- URL: https://github.com/thoughtbot/proteus
- Owner: thoughtbot
- License: mit
- Archived: true
- Created: 2014-10-17T04:02:49.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-09T01:47:43.000Z (over 7 years ago)
- Last Synced: 2024-07-20T11:42:57.271Z (4 months ago)
- Language: Ruby
- Homepage: http://thoughtbot.github.io/proteus
- Size: 379 KB
- Stars: 254
- Watchers: 44
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Proteus
**Note:** Proteus is no longer being actively maintained.
Proteus is a collection of useful starter kits to help you prototype
faster. They follow the [thoughtbot styleguide](https://github.com/thoughtbot/guides)
and includes our favorite front-end development tools.
## Kits
* [Middleman](http://github.com/thoughtbot/proteus-middleman)
* [Jekyll](http://github.com/thoughtbot/proteus-jekyll)
* Have a request for another kit? Open an issue to let us know.
## Installation
1. Install the Proteus gem using the [RubyGems](https://rubygems.org) package manager:
```bash
gem install proteus-kits
```
2. Then kick off a new project with the kit you want to use (i.e. Middleman):
```bash
proteus new middleman your-project-name
```
## Shortcuts
We’ve also included some handy shortcuts with Proteus:
- Install dependencies and clear the Git remote:
```bash
proteus setup
```
- Start the kit-specific server (i.e. `bundle exec middleman server`):
```bash
proteus server
```
- Run the kit-specific deploy (i.e. `middleman deploy`):
```bash
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](https://github.com/thoughtbot/proteus/compare).
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details on contributing and running test.
Thank you to all [the contributors](https://github.com/thoughtbot/proteus-middleman/contributors)!
## Credits
[](http://thoughtbot.com)
Proteus is maintained and funded by [thoughtbot, inc](http://thoughtbot.com). Thank you to all of [the contributors](https://github.com/thoughtbot/proteus-middleman/contributors)!
## License
Copyright © 2014–2016 [thoughtbot, inc](http://thoughtbot.com). Proteus is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).