web/query/README.md

   1 # Sofa: Standalone CouchDB Blog
   2
   3 Sofa showcases the [potential of pure CouchDB applications](http://jchris.mfdz.com/code/2008/10/standalone_applications_with_co). It should provide an easy way for people to put thier thoughts online, anywhere there's a running Couch. It's just HTML, JavaScript and the magic of CouchDB.
   4
   5 Currently supports authoring by anyone with the proper roles, and comments from anyone with a user account.
   6
   7 ## Current News
   8
   9 Things are moving crazy fast around here right now as I bring this stuff up to ship-shape for the [CouchDB book](http://books.couchdb.org). I'll be renaming methods and stuff (if I find the time), any API feedback will be appreciated.
  10
  11 ## Install CouchDB
  12
  13 You'll also need CouchDB (verion 0.11 or newer). Once you have that installed and the tests passing, you can install CouchApp
  14 and the blog software.
  15
  16 ## Install CouchApp
  17
  18 CouchApp makes it easy to edit application that are hosted in CouchDB, by keeping a correspondence between a set of files, and a CouchDB design document. You'll use CouchApp to install Sofa in your CouchDB instance.
  19
  20     sudo easy_install couchapp
  21
  22 CouchApp is a set of utilities for developing standalone CouchDB applications You can [learn more about the CouchApp project here](http://github.com/couchapp/couchapp/). Also, [`easy_install` has an unpleasant bug on OSX](http://mail.python.org/pipermail/pythonmac-sig/2008-October/020567.html), so you might end up having to work from git source.
  23
  24
  25 ### Setup Admin Access
  26
  27 If you are going to put your blog in public, you'll want to [set up an Admin account (screencast)](http://www.youtube.com/watch?v=oHKvV3Nh-CI).
  28
  29
  30 ## Install Sofa
  31
  32     git clone git://github.com/jchris/sofa.git
  33     cd sofa
  34     couchapp push . http://user:pass@127.0.0.1:5984/myblogdb
  35
  36 You'll want to edit the HTML and CSS to personalize your site. Don't worry, the markup is pretty basic, so it's easy to rework. Adding new features is just a few lines of JavaScript away.
  37
  38 Anytime you make edits to the on-disk version of Sofa, and want to see them in your browser, just run `couchapp push . http://127.0.0.1:5984/blogdb` again. **You probably want to setup your `.couchapprc` file.** You should read the CouchApp readme to learn about that.
  39
  40 You can customize the blog title and other stuff in the `blog.json` file.
  41
  42 # Relax
  43
  44 [Visit your new blog.](http://127.0.0.1:5984/blogdb/_design/sofa/_list/index/recent-posts?descending=true&limit=5)