Skip to content
A mountable Rails blogging engine
Ruby JavaScript
Pull request Compare This branch is 26 commits ahead, 360 commits behind KatanaCode:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.yardoc
app
config
db/migrate
doc
lib
script
spec
.gitignore
.rspec
Gemfile
Guardfile
MIT-LICENSE
README.md
Rakefile
magazine.gemspec

README.md

Magazine (beta)

Magazine is a flexible blogging solution for Rails apps. It:

  • Is Rack based;
  • Is a complete MVC solution based on Rails engines;
  • Aims to work right out of the box but remain fully customisable.

Installation

Add this to your Gemfile

gem "magazine"

...and run bundle install to install the gem.

Next, run:

# add an initializer to config/initializers with all of the configuration options
$ rails g magazine:install
# This will add the necessary migrations to your app's db/migrate directory
rake magazine:install:migrations
# This will run any pending migrations
rake db:migrate

then add the following to your routes.rb file:

# config/routes.rb
mount Magazine::Engine => "/blog"

... and finally, declare which of your models acts as blogger in your app (usually User).

class User

  blogs

end

Configuration

Running rails g magazine:install will add an initializer file named magazine.rb. In here you can set various configuration options. Please read the documentation for a full list of the options available.

At no extra cost...

we'll also throw in:

  • An XML Sitemap located at /blog/articles.xml
  • An RSS feed located at /blog/articles.rss
  • Page Caching and Sweeping

Issues

If you discover a problem with Magazine, please let us know about it.

Remember to search the issues list first in case your issue has already been raised by another Githuber

Documentation

Full documentation is available here: http://rubydoc.info/gems/magazine

Contributing

You're welcome to contribute to Magazine. Please consult the contribution guidelines for more info.

Legal Stuff

Copyright 2011 Katana Code Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Credits

Developed by katana:code

About katana:code

katana:code are Ruby on Rails Developers Based in Edinburgh, Scotland.

Something went wrong with that request. Please try again.