bamboo-2010.2.25: readme.md

# Bamboo: a blog engine on hack


Bamboo is a port of [Panda](http://github.com/nfjinjing/panda/tree), but runs on top of Hack. It's an experimental project but quite portable.

## Note

The Bamboo codebase is a mess!!! But Haskell is so reliable that left me no incentive to do a rewrite.

So just use it, build middleware for it, or better yet write a new blog engine so everyone can benefit :)

## Features

### plain text as data source

    db
    |---- blog
    |     |---- 08-09-01 first post
    |     |---- 09-09-02 learn javascript.html
    |
    |---- tag
    |     |---- programming
    |     |---- funny
    |
    |---- static
          |---- About

### simple config

    blog_title    = C大调
    blog_subtitle = 野猫不吃薯片
    host_name     = jinjing.easymic.com
    author_email  = nfjinjing@gmail.com

    navigation    = About
    per_page      = 7
    sidebar       = Blogroll.md
    favicon       = bamboo_icon.png

### hacker friendly

* posts are in plain text
* SCM for publishing / data managing ( not really a feature, but a design goal from the beginning )
* blindly follows the KISS principle from code to UI: be a simple blog, no more no less

### modular

By it's middleware nature, bamboo could be used with other hack middleware to achieve extensibility; Bamboo plugins are also middleware, so they can be used not only in bamboo, but any other CMS like web application.

## [Demo](http://jinjing.funkymic.com)

## Easy install in 3 steps

### 1. update cabal

    cabal update

### 2. install bamboo

    cabal install happy
    cabal install bamboo-launcher

### 3. run

    mkdir myblog
    cd myblog
    bamboo

## Bird view architecture

    hack-interface :
      1. bamboo-hack-compatible-layer -- bamboo-controller -- bamboo-theme
      2. [ bamboo-plugins ]
      3. [ hack-middleware-stack ]

## Customize

bamboo can be customized in 3 ways:

### Theme

Theme is separated from the bamboo's controller, connected through an interface and a state.

Though theme could be pure, it has the type of
    
    data Interface = 
        Index
      | IndexFeed
      | Post
      | Static
      | Tag
      | TagFeed
      | Search
      deriving (Show, Eq)
    
    type Theme = Interface -> State -> IO Response

This makes theme creation a relatively complex task, since a theme author basically has to do everything: from html construction to model manipulation. But since state is passed purely and return type is in IO, it also provides the ultimate safety and flexibility to theme construction, something unmatched by any main stream web frameworks. Integrating twitter? no problem, do them in IO.

### Plugin

Plugin is a proper hack middleware, so it works on an upper layer of the blog engine. It has all the power of a middleware, i.e. intercept request and response, and also the limitation, e.g. no idea of the underlying data structure of the app.

Plugin can be used to to do customization on the env object, or transformation to the response body. An example plugin is [syntax highlighting](http://github.com/nfjinjing/bamboo-plugin-highlight), which could be done in the core, but would be more lightweight ( in terms of architecture design ) to be separated into a plugin.

You are hence not limited to use just bamboo-plugins to customize your blog, any hack-middleware which suite your need will do.

### Javascript / CSS

In `db/config/theme`, you can customize precisely which `js / css` files to use, this allows client side customization and also lightweight configuration without compilation.

## Links

* [Hack](http://github.com/nfjinjing/hack)
* [Hack Contrib](http://github.com/nfjinjing/hack-contrib)
* [bamboo-theme-blueprint](http://github.com/nfjinjing/bamboo-theme-blueprint)
* [bamboo-theme-mini-html5](http://github.com/nfjinjing/bamboo-theme-mini-html5)
* [bamboo-launcher](http://github.com/nfjinjing/bamboo-launcher)
* [bamboo-plugin-highlight](http://github.com/nfjinjing/bamboo-plugin-highlight)
* [bamboo-plugin-photo](http://github.com/nfjinjing/bamboo-plugin-photo)

## That's it

郑板桥（1693~1765） 修竹幽兰图

<a href="http://github.com/nfjinjing/bamboo/raw/master/bamboo.jpg">
  <img src="http://github.com/nfjinjing/bamboo/raw/master/bamboo-thumb.jpg" />
</a>