aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
blob: 15ea98f178deee616a9dd2aa39362abaf08a91e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
#  The Gödel-Gentzen Clojure Syndication Services Super System

CljSSSS<sup>g</sup> is a web-based feed reader written in Clojure.

## Dependencies

CljSSSS<sup>g</sup> requires the following items to be on the class path:

 - [Clojure](http://clojure.org/)
 - [Clojure Contrib](http://code.google.com/p/clojure-contrib/)
 - [Compojure](http://groups.google.com/group/compojure) along with all of its dependencies, including:
   * [Fact](http://github.com/weavejester/fact)
   * [Jetty](http://www.mortbay.org/)
   * [Rend](http://github.com/weavejester/rend)
   * The [Apache Commons Logging API](http://commons.apache.org/logging/)
   * The [Java Servlet API](http://java.sun.com/products/servlet/)
 - [StringTemplate](http://www.stringtemplate.org/) along with [ANTLR](http://www.antlr.org/)
 - [ROME](https://rome.dev.java.net/) along with [JDOM](http://www.jdom.org/)
 - [SQLiteJDBC](http://zentus.com/sqlitejdbc/) (if you want to deploy using SQLite)

## Deployment

First, if you want the fancy JavaScript-based UI features, you need to either

 1. call `git submodule update --init`, **or**
 2. download the [Yahoo! UI Library, version 3](http://developer.yahoo.com/yui/3/), and extract it into the directory `public/yui3` (in such a way that `public/yui3/src` contains the JavaScript code).

If you decide not to do this, however, you're still left with a fully-functional, though boring, HTML-based UI.

In order to run CljSSSS<sup>g</sup>, load the main file, `cljssss-g.clj`.

You will probably want to populate your database with a couple of user records before trying to log in.  See the bottom of the `cljssss-g.clj` file for the database schema and examples.

<!--
Local Variables:
  mode: markdown
  coding: utf-8
End:
-->