Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 45 lines (33 sloc) 2.065 kB
c13b029 @zk Added db:clean_dump cap task, which anonymizes the database and dumps it
authored
1 # ClojureDocs Web App
2
684b6f1 @zk Added overview text to readme
authored
3 [ClojureDocs](http://clojuredocs.org) is a community powered documentation and examples repository designed to aid clojurists of all skill levels in groking clojure core and third party libraries.
4
5 The alpha version of ClojureDocs was released on July 9th, 2010. See the [original mailing list post](http://groups.google.com/group/clojure/browse_thread/thread/a97d472679f2cade/810b73543fd6a2a5?q=clojuredocs&lnk=ol&) for more information.
6
7 ClojureDocs consists of three main projects: this website, the [library importer](https://github.com/zkim/clojuredocs-analyzer), and the [external API](http://github.com/dakrone/cd-wsapi.git).
8
f69e52b @zk Updated readme with current build instructions.
authored
9 ## Requirements
10 * Ruby 1.8.7 & Rails 2.1.5.
11 * MySQL 5.1
12 * bundler
13 * Sphinx 0.9.9
14 * RVM - not required, but highly suggested.
99da426 @zk Initial commit after nuking history (pws and keys in history).
authored
15
f69e52b @zk Updated readme with current build instructions.
authored
16 ## Getting Started
17 * Open up a terminal.
18 * Clone the repo: `git clone https://github.com/zkim/clojuredocs.git`
19 * `cd clojuredocs`
20 * Copy the database template: `cp ./config/database.example.yml ./config/database.yml`
21 * Install required gems: `bundle install`
22 * Create the required databases: `echo 'create database clojuredocs_development; create database clojuredocs_test' | mysql -uroot`
23 * Run database migrations: `rake db:migrate`
24 * Start the dev server: `script/server`
4de2fcc @zk Readme tweaks
authored
25 * Navigate to `http://localhost:3000`
f69e52b @zk Updated readme with current build instructions.
authored
26
27
28 This will give you a pristine working version of ClojureDocs. Not very interesting without data, so lets import some:
29
30 * Download the latest [database export](https://github.com/zkim/clojuredocs/downloads)
efaa9ab @zk Fixed database import process error in README
authored
31 * Import the database: `mysql -uroot clojuredocs_development < downloaded_export_file`
f69e52b @zk Updated readme with current build instructions.
authored
32 * Refresh `http://localhost:3000`
33
34 Enabling search requires sphinx
35
36 * Download `http://www.sphinxsearch.com/downloads/sphinx-0.9.9.tar.gz`
37 * Unzip and cd into the sphinx directory
38 * `./configure`
39 * `make`
40 * `sudo make install`
91007a1 @zk Minor readme tweaks
authored
41 * Back in the clojuredocs project directory: `rake thinking_sphinx:rebuild` This will index the database and start the sphinx search daemon.
99da426 @zk Initial commit after nuking history (pws and keys in history).
authored
42
43
7129c2a @zk Added epl 1.0 file and license info to README
authored
44 ## License
45 ClojureDocs is licensed under the EPL v1.0 http://opensource.org/licenses/eclipse-1.0.php
Something went wrong with that request. Please try again.