Build Status Dependency Status Dependency CI Coverage Status Code Climate Gem Version License

Skellington

Extremely opinionated generator for your Sinatra app or Jekyll site. Sets up:

Should work fine for both RVM- and rbenv-based setups

Installation

git clone https://github.com/pikesley/skellington
cd skellington
bundle
rake
rake install

or just

gem install skellington

Usage

Sinatra

$ skellington generate naming-things-is-hard --licensor 'Beyoncé'
Generating <lots of stuff>... done

Your new Sinatra app NamingThingsIsHard has been created

(Note that 'naming-things-is-hard' has been changed to 'naming_things_is_hard' because Ruby finds '-'s troubling)

Now do

    cd naming_things_is_hard
    bundle
    bundle exec rake

And presuming that passes OK

    git add .
    git commit -m 'First commit'

Then try (in 2 different windows)

    bundle exec rake run:sass
    bundle exec rake run:app

which will launch Compass and then run the app (at http://localhost:9292)

For post-install hints, try

    skellington postinstall

Jekyll

$ gem install skellington
$ skellington generate hello-from-the-magic-tavern --framework jekyll
Generating <lots of stuff>... done

Your new Jekyll site HelloFromTheMagicTavern has been created

(Note that 'hello-from-the-magic-tavern' has been changed to 'hello_from_the_magic_tavern' because Ruby finds '-'s troubling)

Now do

    cd hello_from_the_magic_tavern
    bundle
    bundle exec jekyll serve

which will launch the site (at http://localhost:4000/hello-from-the-magic-tavern/)

And presuming that works OK

    git add .
    git commit -m 'First commit'

You should also fill in your name in LICENSE.md

Options

  • --framework

    • Framework for which to generate
    • Default: sinatra
    • Possible values: sinatra, jekyll
  • --bootstrap

    • Bootstrap major version to include
    • Default: 3
    • Possible values: 3, 4
    • VERY EXPERIMENTAL
  • --licensor

    • Name to include in the license file

This all assumes a bunch of things, at least:

  • That you have a reasonable git installation

Also, it will set up the new project using whatever version of ruby is cromulent when you run it