isabella232 / shipyard-1

A lightweight, CSS framework for Rails & Jekyll applications

Shipyard

A light-weight, powerful, front-end framework for faster web development and useful tools for Ruby on Rails and Jekyll enthusiasts.

Installation

Add this line to your application's Gemfile:

gem 'shipyard-framework'

And then execute:

$ bundle

Or install it yourself as:

$ gem install shipyard-framework

Then add this line to your application's CSS file(s):

@import "shipyard"

If you're using Jekyll, make sure you add the following the code in your _config.yml file:

plugins:
  - shipyard-framework

Running Builds on Codeship Pro

1. Install Homebrew
2. Run brew bundle
3. Run jet steps

Running Builds on Jenkins

1. Install Homebrew
2. Run brew bundle
3. Run jenkins
4. Open Jenkins

Running Jekyll Locally via Docker

1. Install Docker for Mac
2. Run rake shipyard:run

Status

Development Workflow

Shipyard uses Codeship Basic to automate the testing and deployment workflows. If you would like to make a contribution to this project, all tests will need to pass and an administrator will need to approve the changes before they can be merged into master.

Bugs & Feature Requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

License

The gem is available as open source under the terms of the MIT License.