Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 51 lines (35 sloc) 1.65 kB
c8fe19b added rspec and capybara
jipiboily authored
1 # MONOLOGUE
2
e200b30 Modified README
jipiboily authored
3 Monologue is a somewhat basic mountable blogging engine in Rails built to be easily mounted in an already existing Rails app, but it can also be used alone.
c8fe19b added rspec and capybara
jipiboily authored
4
5 ## Features
6 - Rails mountable engine
7 - fully named spaced
8 - well tested
e200b30 Modified README
jipiboily authored
9 - as less external dependencies as possible (no Devise or Sorcery, etc…) so we don't face problem integrating with existing Rails app.
c8fe19b added rspec and capybara
jipiboily authored
10 - comments handled by disqus
11 - using [Rails cache](http://edgeguides.rubyonrails.org/caching_with_rails.html) for better performance
12 - runs on Heroku (must disable caching in main_app)
13
14
15 ## Installation
16
e200b30 Modified README
jipiboily authored
17 1. add gem
18 gem "monologue"
19 2. bundle install
20 3. add this to your route file
21 mount Monologue::Engine, :at => '/' # or whatever path, be it "/blog" or "/monologue"
22 4. bundle exec rake monologue:install:migrations
23 5. Create a user
24 rails c
25 Monologue::User.create(name: "jipiboily", email:"j@jipi.ca", password:"password", password_confirmation: "password")
c8fe19b added rspec and capybara
jipiboily authored
26
e200b30 Modified README
jipiboily authored
27 ## Customization
c8fe19b added rspec and capybara
jipiboily authored
28
e200b30 Modified README
jipiboily authored
29 - RSS feed URL is "/feed"
c8fe19b added rspec and capybara
jipiboily authored
30
31
e200b30 Modified README
jipiboily authored
32 ## Requirements
33 - Rails 3.1.3 +
34 - Database: MySQL & Postgres support (SQLite?)
35
c8fe19b added rspec and capybara
jipiboily authored
36 ## Ideas for the future
37
38 - use [jQuery Waypoints](http://imakewebthings.github.com/jquery-waypoints/) to suggest another article (might be chosen from and?) once the article is read.
39 - An example: [See the "recommended story" once you reach the bottom of article](http://www.readwriteweb.com/archives/the_other_1_people_who_still_use_ie6.php)
40
41 - plugins
42 - themes (with Deface)
43
44 - easy contact form for an about page
45 - configurations in the database
46
47 - multiple sites with only one intance
48
e200b30 Modified README
jipiboily authored
49 ## Contribute
50
51 Fork it, the pull request. Please add tests for your feature or bug fix.
Something went wrong with that request. Please try again.