tgsoverly / conclave

Soon to be the greatest web forum EVER DEVISED.

Conclave

Conclave is a web forum application that the Columbus Ruby Brigade is crafting. It is released under the MIT license.

The project was started on 9/8/2012 and is under development. It is not recommended to use at this point.

This project will start as a Rails application, but once approaching release we'll repackage as a gem that will integrate into an existing Rails application.

Goals

1. Teach the beauty of the Ruby and Rails stack
2. Lower the Open Source contribution barrier
3. Release useful, working software.

Tools

• Web Host - Heroku
• Ruby (1.9.2) - Ruby
• Web Framework - Rails
• Testing Frameworks - RSpec & Cucumber
• Local Database - SQLite
• Templating language - Slim
• Javascript Library - jQuery
• CSS Framework - Compass-Rails
• Form Helper - SimpleForm
• Authentication - Devise
• Authorization - CanCan
• File Upload - Paperclip
• Admin Panel - ActiveAdmin

Services

• Travis CI
• User Avatars - Avatars.io

How to contribute

All contributions are welcome! Please follow these steps for easy contributions:

1. Clone the repo locally
2. Implement your code changes
3. Test your changes -- I'm more concerned with testing the intent of your code, not it's implementation. If it's a smallish change, write a unit test or two. If it's a larger feature, we'll need a Cucumber scenario(s).
4. Submit a Pull Request on Github!

How to test

rake db:test:create
rake db:test:clone
rake

How to install and run the app locally

Clone the repo locally
Download and install a copy "clone" of the application on your own computer.
At the command prompt in your terminal window, type (or copy and paste) the repo address and hit enter.

$ https://github.com/columbusrb/conclave.git

This will create a new folder named conclave and download the app into that folder. Once all of the files are downloaded, switch to the conclave folder.

$ cd conclave

Install all of the required Gems
At the command prompt in your terminal window, type the following command and hit enter.

[conclave]$ bundle install

Run all of the migrations
At the command prompt in your terminal window, type the following command and hit enter.

[conclave]$ rake db:migrate

Generate initial User accounts and starter data
At the command prompt in your terminal window, type the following command and hit enter.

[conclave]$ rake db:seed

This will create three User accounts. This first two are User accounts with the role "contributor." The third is a User account with the role "admin."

1. [email protected] with "please" as the password
2. [email protected] with "please" as the password
3. [email protected] with "password" as the password

Fire it up!
Start the server on your computer.
At the command prompt in your terminal window, type the following command and hit enter.

[conclave]$ rails server

After you hit enter, you'll see something like this in the terminal window which lets you know the server is running.

=> Booting WEBrick
=> Rails 3.2.8 application starting in development on http://0.0.0.0:3000
=> Call with -d to detach
=> Ctrl-C to shutdown server
[2012-10-18 04:42:01] INFO  WEBrick 1.3.1
[2012-10-18 04:42:01] INFO  ruby 1.9.2 (2012-04-20) [x86_64-darwin11.4.2]
[2012-10-18 04:42:01] INFO  WEBrick::HTTPServer#start: pid=2838 port=3000

Open the App
Open a web browser, enter the web address for the local server and hit enter.

http://0.0.0.0:3000

or

http://localhost:3000

Sign in to the App
In the upper right-hand corner of the home page, click Sign in. Use one of the usernames listed above to sign in.