Giter VIP home page Giter VIP logo

gumdrop's Introduction

Gumdrop

Gumdrop; The sweet cms/prototyping tool.

It generates static html and includes a dev server that can be run via any rack server (including POW!).

Install

$ gem install gumdrop

Quick Start

$ gumdrop new SITE_NAME

(You can run gumdrop help to see a list of commands and their supported flags.)

Gumdrop will spit out a default Gumdrop project site for you, which you can then build by running:

$ cd SITE_NAME
$ gumdrop build

Bam! A static version of the site is now available in a newly created ./output folder.

Don't want the output there? Maybe you want it to put it in ./public instead? No problem. Open up the Gumdrop project file:

$ $EDITOR Gumdrop

At the top of the file you'll find a Gumdrop.configure block. Add this to the top of that block:

Gumdrop.configure do |config|

  config.output_dir= "./public"

  # ... Other stuff

end

Now, when you run gumdrop build again, it'll generate all the output into the ./public folder (creating it, if it doesn't exist).

Lots More

That's enough to get you started! Poke around the code it generated to see how it works. You can also start with a blank slate by running:

$ gumdrop new -t blank MY_BLANK_SITE

Gumdrop can do quite a lot and is very configurable. Be sure and read the wiki for documentation and more examples!

https://github.com/darthapo/gumdrop/wiki

By The Power of...

Greyskull? Well, not so much. But Gumdrop core is powered by these excellent open source projects (in alphabetical order):

  • ActiveSupport
  • Bundle
  • Launchy
  • Onfire
  • Sinatra
  • Tilt
  • Thor

And will, optionally, leverage these in building your site:

  • coffee-script
  • erb
  • haml/sass
  • jsmin
  • slim
  • sqlite3
  • sprockets
  • stitch
  • and many, many more! (todo: gotta document 'em all!)

gumdrop's People

Contributors

mattmccray avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

grijzehaar

gumdrop's Issues

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.