Skip to content

Commit

Permalink
Updated readme with current build instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
zk committed Oct 20, 2010
1 parent c13b029 commit f69e52b
Showing 1 changed file with 32 additions and 25 deletions.
57 changes: 32 additions & 25 deletions README.md
@@ -1,31 +1,38 @@
# ClojureDocs Web App

## Getting Started

## Gems
sudo gem install bundler
bundle install

## Import DB
create the following databases in MySQL: clojuredocs_development, clojuredocs_test
rake db:migrate
rake db:migrate RAILS_ENV=test

## Run Tests
rake test
## Requirements
* Ruby 1.8.7 & Rails 2.1.5.
* MySQL 5.1
* bundler
* Sphinx 0.9.9
* RVM - not required, but highly suggested.

## Start Server
script/server

## Search (Optional)
http://www.sphinxsearch.com/downloads/sphinx-0.9.9.tar.gz
(in tarball dir)
./configure
make
sudo make install

(in project dir)
rake thinking_sphinx:rebuild
## Getting Started
* Open up a terminal.
* Clone the repo: `git clone https://github.com/zkim/clojuredocs.git`
* `cd clojuredocs`
* Copy the database template: `cp ./config/database.example.yml ./config/database.yml`
* Install required gems: `bundle install`
* Create the required databases: `echo 'create database clojuredocs_development; create database clojuredocs_test' | mysql -uroot`
* Run database migrations: `rake db:migrate`
* Start the dev server: `script/server`
* Navigate to "http://localhost:3000"


This will give you a pristine working version of ClojureDocs. Not very interesting without data, so lets import some:

* Download the latest [database export](https://github.com/zkim/clojuredocs/downloads)
* Import the database: `mysql -uroot clojuredocs_production < downloaded_export_file`
* Refresh `http://localhost:3000`

Enabling search requires sphinx

* Download `http://www.sphinxsearch.com/downloads/sphinx-0.9.9.tar.gz`
* Unzip and cd into the sphinx directory
* `./configure`
* `make`
* `sudo make install`
* Back in the clojuredocs project directory: `rake thinking_sphinx:rebuild`


## License
Expand Down

0 comments on commit f69e52b

Please sign in to comment.