Skip to content

Home

Jump to bottom
Jude Tucker edited this page Aug 2, 2016 · 3 revisions

The Flying Dutchman

Pirate by Richard Cordero from the Noun Project

The Flying Dutchman helps users jump-start their Ruby on Rails projects by installing a basic SCSS framework that is made to be extended. Simply choose your basecoat and start customizing.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisities

For this gem we are assuming that you have a Ruby on Rails project that is Rails >= 3.1. And your file structure contains the following files/folders

|-- app
|   |-- assets
|   |   |-- images
|   |   |-- javascripts
|   |   |   `-- application.js
|   |   `-- stylesheets
|   |       `-- application.css(or .scss)
`-- vendor
	`-- assets
	    |-- javascripts
	    `-- stylesheets

Installing

Here are the steps to jumpstart you.

In your Gemfile, add this line:

gem 'flying_dutchman'

Run bundle install from your app directory:

$	bundle install

Now the Dutchman is installed, but not set up.

Choose a Captain

"The Dutchman must always have a captain"

Select a captain, or base-coat framework, that you will start with and customize / extend the functionaliy out from there.

Options for Captain are:

Normalize

This is the most minimal of the setup options. This simply loads the normalize.css project into you app to set you on the right track for customization. Use this option if you fully intend to build everything yourself and need no framework or base-coat of any kind.

Credit for Normalize goes to Nicolas Gallagher (@necolas) Normalize

Skeleton

This option is for users who need some framework such as a basic grid, typeography and some componants. This framework is made to be extremely lightweight and no frills. Use this if you have a small project that doesn't need much or you want to do most of the work yourself.

Credit for Skeleton goes to Dave Gamache (@dhg) Skeleton

Skeleton

This option is for users who need some framework such as a basic grid, typeography and some componants. This framework is made to be extremely lightweight and no frills. Use this if you have a small project that doesn't need much or you want to do most of the work yourself.

Credit for Skeleton goes to Dave Gamache (@dhg) Skeleton

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Dropwizard - Bla bla bla
  • Maven - Maybe
  • Atom - ergaerga

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc
Clone this wiki locally