Sha256: 9416c77ac071387647acd9cd2b9e3a6aa491b3572be969f7fb5bd0317158a372
Contents?: true
Size: 1.02 KB
Versions: 7
Compression:
Stored size: 1.02 KB
Contents
# Thredded (the gem / rails engine)
## Installation
Add the gem to your Gemfile:
```ruby
gem 'thredded'
```
Add an initializer to your app: `config/initializers/thredded.rb`
```ruby
Thredded.user_class = 'User'
Thredded.email_incoming_host = 'incoming.example.com'
Thredded.email_from = 'no-reply@example.com'
Thredded.email_outgoing_prefix = '[Thredded] '
Thredded.user_path = ->(user){ "/path/to/where/you/show/#{user}" }
```
Copy the migrations over to your parent application and migrate:
```
rake thredded:install:migrations db:migrate db:test:prepare
```
Mount the thredded engine in your routes file:
```
mount Thredded::Engine => '/forum'
```
## Get Your App Ready
There are a few things you need in your app to get things looking just right.
1. Add a to_s method to your user model. The following example assumes a column in my user model called `name`:
```ruby
class User < ActiveRecord::Base
def to_s
name
end
end
```
For more information see [the full-fledged rails app](https://github.com/jayroh/thredded_app)
Version data entries
7 entries across 7 versions & 1 rubygems