sfeu / kakuteru Goto Github PK

Urgent note: the Kakuteru trunk is at the moment way behind the Kakuteru.com - it needs syncing up!

= Kakuteru

Is a Web 3.0 enabled Lifestreamer.

== Background

For my blog, I have been using Mephisto for several years now. It's a fine piece of Ruby, but I found it extremely difficult to customize (has everything to do with their Liquid templating engine). For a while now I've been meaning to write my own hackable blogging software. Kakuteru is however much more than just blogging software.

Luckily I started mashing this together after witnessing an awesome presentation by Yongfook. He developed Sweetcron, an open source Lifestreamer written in PHP. Sweetcron beautifully combines online micro activity with editorial blogging content. As you will notice, I ripped off Yongfook's design almost completely (hence the attribution in the footer). Although greatly inspired by, Kakuteru is not just the Rails version of Sweetcron. Kakuteru is focussed on:
- integrating Semantic and intelligent services
- improving Machine readability by supporting micro- and nanoformats
- keeping in mind SEO by conforming to web standards, pinging blog aggregators and inviting social bookmarking

Basic Features:
- Uses friendfeed.com as a core lifestream backend (tweets, video, photo and bookmarks currently supported)
- Uses Disqus.com to support comments on articles & stream updates
- Articles can be written using Textile, Markdown or HTML
- Published articles will display Tweet-this, Digg and Addthis.com if voting is enabled
- "Me on other sites" are automatically gathered from Friendfeed

Semantic Features
- Autotagging of tweets and articles using Zemanta.com
- Related articles & tweets are shown for each entry

Microformats supported:

Nanoformats supported:

== Dependencies

sudo gem install will_paginate
sudo gem install xml-simple
sudo gem install mechanize
sudo gem install BlueCloth
sudo gem install mofo
sudo gem install icalendar

== Installation

1. Configure your config/database.yml.
2. Start the rails server.
3. Go to: http://url/dashboard/
4. Make sure to configure your friendfeed_url
5. Make sure to register a Zemanta API key @ http://developer.zemanta.com/ and set it in config/environment.rb:

  ZEMENTA_API_KEY = 'your key'
  
6. To update the lifestream run: ./script/runner Post.fetch_from_friendfeed

== Migrate from Mephisto

Yes, Mephisto is dead baby!

Setup your mephisto database in config/database.yml:

migrate_from_mephisto:
  adapter: mysql
  database: mephisto_database
  
Run:

# Make backup first
./script/runner db/migrate/from_mephisto.rb # Dump all mephisto articles to ./articles.yml
./script/runner db/migrate/from_mephisto.rb load_dump
  
== LICENSE

All Kakuteru code is licensed under Creative Commons Attribution 3.0 (the Netherlands jurist diction): http://creativecommons.org/licenses/by/3.0/nl/deed.en