Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 121 lines (85 sloc) 4.251 kB
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
1 # rBoard
a9fe24e @radar Perhaps, make it markdown?
radar authored
2
68d7e76 @radar Organisation of the modules.
radar authored
3 rBoard is a kick-ass forum system built in Ruby on Rails. One of it's primary goals is being able to set it up quickly and easily, and still have it blow your mind with an awesome and stable feature set. It's now one year old as of March 10th, 2009.
4
5 If you're looking to integrate it into a site, please read the Integration section below.
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
6
6f0131c @radar Fix up README
radar authored
7 It's currently under active development.
8
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
9 ## How to get it up and running
10
6f0131c @radar Fix up README
radar authored
11 In order to start using rBoard you should only have to clone the repository
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
12
b66c638 @radar Fix typo in README pointed out by Nick Kezhaya.
radar authored
13 git clone git://github.com/radar/rboard.git rBoard
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
14 cd rBoard
60af975 @radar Update readme
radar authored
15 rake install
6a6b8cd @radar Remove excessive whitespace.
radar authored
16
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
17 ## Requirements
18
19 This app requires Sphinx which can be obtained from the Sphinx [website](http://sphinxsearch.com). Sphinx works with both MySQL and PostgreSQL.
0141d71 @radar Added spaces where relevant.
radar authored
20
60af975 @radar Update readme
radar authored
21 Alternatively, you could just set `THINKING_SPHINX = false` in _config/environment.rb_
0141d71 @radar Added spaces where relevant.
radar authored
22
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
23 ### Sphinx Installation
24
25 1. download Sphinx
26 2. extract it
27 3. run `./configure && make && sudo make install`
6a6b8cd @radar Remove excessive whitespace.
radar authored
28
e2df848 @radar Testing th
radar authored
29 ## Features
30
31 rboard has the following awesome things:
6a6b8cd @radar Remove excessive whitespace.
radar authored
32
2ac65a2 @radar Updated README removing 2.2 compatibility and add link to issues tracker
radar authored
33 * Runs on Rails 2.3 only (sorry!)
34 * Can run on 2.x but requires a few lines to be removed.
0ae22c5 @radar Add internationalisation message.
radar authored
35 * Easy Internationalisation Support
2ac65a2 @radar Updated README removing 2.2 compatibility and add link to issues tracker
radar authored
36 * Detailed permissions system
e2df848 @radar Testing th
radar authored
37 * Categories (can be ordered)
38 * Forums (can be ordered)
44e84fd @radar Added feature list
radar authored
39 * List topics with subject, author, replies, views and last post information
40 * Can be restricted to certain user levels (visible to and topics created by)
41 * Sub forums (infinitely. No, really. Try it.)
42 * RSS Feeds
e2df848 @radar Testing th
radar authored
43 * Topics
44e84fd @radar Added feature list
radar authored
44 * Locking
45 * Sticky-ifying
46 * Splitting
47 * Merging
48 * Subscriptable
49 * Moveable
50 * Editable
51 * Deletable
52 * Paginated (will_paginate)
53 * RSS Feeds
e2df848 @radar Testing th
radar authored
54 * Posts
44e84fd @radar Added feature list
radar authored
55 * Reply
56 * Quote
57 * Editable (it tracks these too!)
58 * Deletable
59 * Quick Reply
60 * Code Highlighting (syntax gem)
61 * Paginated (will_paginate)
e2df848 @radar Testing th
radar authored
62 * Users
44e84fd @radar Added feature list
radar authored
63 * IP Tracking
64 * Signatures
65 * Member Lists
66 * User Levels (Anonymous, User, Moderator & Administrator)
67 * IP Banning
68 * Ranks
69 * Post dependent or custom
70 * Themes
71 * Upload your new theme directory into public/themes and go!
72 * Private Messaging
73 * Tracks read topics on a per-user basis
e2df848 @radar Testing th
radar authored
74 * Searching (courtesy of ThinkingSphinx)
44e84fd @radar Added feature list
radar authored
75
6a6b8cd @radar Remove excessive whitespace.
radar authored
76
e2df848 @radar Testing th
radar authored
77 Puppies, Kittens, Rainbows and Unicorns sold separately.
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
78
79 ## OAQ (Occasionally Asked Questions)
80
81 1. Why?
a9fe24e @radar Perhaps, make it markdown?
radar authored
82
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
83 Why not? I use forum systems every day and I figured the best way to learn more about Rails was to build one in it. rBoard's evolved into much, much more now and is my favourite project to work on.
a9fe24e @radar Perhaps, make it markdown?
radar authored
84
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
85 2. Who?
a9fe24e @radar Perhaps, make it markdown?
radar authored
86
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
87 One developer, so far. My name's Radar, but sometimes people call me Ryan or "dickhead". I wrote all of the code you see before you today.
a9fe24e @radar Perhaps, make it markdown?
radar authored
88
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
89 3. What?
a9fe24e @radar Perhaps, make it markdown?
radar authored
90
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
91 This is rBoard, a forum system built in Rails.
a9fe24e @radar Perhaps, make it markdown?
radar authored
92
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
93 4. How?
a9fe24e @radar Perhaps, make it markdown?
radar authored
94
6f0131c @radar Fix up README
radar authored
95 To install it, go through the integrated installer inside the application itself. (Found at /install)
a9fe24e @radar Perhaps, make it markdown?
radar authored
96
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
97 5. When (is it stable)?
a9fe24e @radar Perhaps, make it markdown?
radar authored
98
6f0131c @radar Fix up README
radar authored
99 The `master` branch is usually kept in a stable manner. I try to anyway. No guarantees about that.
a9fe24e @radar Perhaps, make it markdown?
radar authored
100
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
101 6. OMG it is broken -- why!?!?
a9fe24e @radar Perhaps, make it markdown?
radar authored
102
2ac65a2 @radar Updated README removing 2.2 compatibility and add link to issues tracker
radar authored
103 If you have any problems, you can log them in [the issue tracker](http://github.com/radar/rboard/issues) or you can contact me, either [through GitHub](http://github.com/inbox/new/radar) or by [emailing me](mailto:radarlistener@gmail.com).
a9fe24e @radar Perhaps, make it markdown?
radar authored
104
818921d @bjeanes Just making the README more kick ass, understandable, and awesome -- …
bjeanes authored
105 7. I love you.
a9fe24e @radar Perhaps, make it markdown?
radar authored
106
2ac65a2 @radar Updated README removing 2.2 compatibility and add link to issues tracker
radar authored
107 You can send money to `radarlistener@gmail.com` on Paypal or click the donate link and I will love you back.
68d7e76 @radar Organisation of the modules.
radar authored
108
488d7af @radar Add subdomain suggestion to readme
radar authored
109 ## Integration
030587d @radar Add disclaimer to README
radar authored
110
111 **Please note:** by no means is integration into an existing site easy. Rails apps are not made to be pluginable. I am waiting for Rails 3 so I can engine-ize rboard and ideally it'll Just Work. Until that magical day of pixies, unicorns, puppies and higher wages, I have no suggestions other than to try it yourself and write about it. I am available most of the time via email. I do not bite. We'll be BFF if you want to use my project.
68d7e76 @radar Organisation of the modules.
radar authored
112
4530764 @radar Clarify that the 'easy way' is not integration
radar authored
113 **There is an easy non-integration way though**: Run rboard as a separate app on a subdomain for your app and point it to the same database. You may wish to customize the user model to use whatever method you authenticate with, since there's a high proabability you're using a separate method to what I am.
6a6b8cd @radar Remove excessive whitespace.
radar authored
114
e359f94 @radar Added the ability to edit configuration options. More are coming later.
radar authored
115 ## Contributors
74706e8 @radar Tom Unsworth was the second contributor for rboard (the first being m…
radar authored
116
117 * Tom Unsworth
832efbf @radar Add subdomain suggestion to readme
radar authored
118 * Thomas Sinclair
119 * Bodaniel Jeanes
120 * Tore Darell
d39833c @radar Can't use User.anonymous here because the user record may not exist […
radar authored
121 * rubygem
Something went wrong with that request. Please try again.