README

   1 -*- text -*-
   2
   3 CL-Trane is a loose collection of utilities that together form a Web
   4 application development framework.  Project's aim is to provide a
   5 comprehensive, yet simple and magic-free Common Lisp framework for
   6 easy creation of RESTful Web applications.
   7
   8 CL-Trane is built upon Hunchentoot (http://weitz.de/hunchentoot/) Web
   9 server, and Postmodern (http://common-lisp.net/project/postmodern/)
  10 interface to PostgreSQL (http://www.postgresql.org/) database.
  11 Py-configparser (http://common-lisp.net/project/py-configparser/) is
  12 used for configuration.
  13
  14 Direct dependencies include also Puri (http://puri.b9.com/), and
  15 Iterate (http://common-lisp.net/project/iterate/), used internally for
  16 looping.  Trane-BB module uses also Meta-sexp
  17 (http://www.cliki.net/meta-sexp), and Trane-Taxonomy uses cl-store
  18 (http://common-lisp.net/project/cl-store/).  Indirect dependencies are
  19 not mentioned; full dependency graph is included in doc/ subdirectory.
  20 Because of number of dependencies, it is recommended to use
  21 CL-Librarian (http://common-lisp.net/project/cl-librarian) for
  22 managing required libraries.
  23
  24 Project home page is http://common-lisp.net/project/cl-trane/.
  25 Current code can be downloaded from Git (http://git.or.cz/) repository
  26 at http://common-lisp.net/project/cl-trane/cl-trane.git/.  Code is
  27 available on terms of BSD license without advertising clause, see file
  28 COPYING for details.
  29
  30 Code is currently at early development stage; docs are incomplete,
  31 there is no fully operating infrastructure yet.  However, it may be
  32 useful as it is now, and feel free to contact author by e-mail, at
  33 maciej@pasternacki.net, or to subscribe to development mailing list at
  34 http://common-lisp.net/cgi-bin/mailman/listinfo/cl-trane-devel .
  35
  36 Currently available modules are:
  37 - trane-common: common, general functionality, used within project
  38 - trane-bb: BBCode parser
  39 - trane-taxonomy: Wordpress-like taxonomy
  40 - trane-passengers: User registration, activation, login cookies
  41 Pattern matching-based URL routing module named trane-routes is on the
  42 way.
  43
  44 Enjoy!
  45 -- Maciej Pasternacki / 3ofcoins.net