Repository files navigation

THIS README IS FOR THE MASTER BRANCH AND REFLECTS THE WORK CURRENTLY EXISTING ON THE MASTER BRANCH. IF YOU ARE WISHING TO USE A NON-MASTER BRANCH OF MONOLOGUE, PLEASE CONSULT THAT BRANCH'S README AND NOT THIS ONE.

NOT MAINTAINED ANYMORE: This project hasn't been maintained for a while. It's pretty basic and should still work. Chances are issues and PRs might not receive the attention they deserve, at least, not quickly, if at all.

Monologue is a basic, mountable blogging engine in Rails built to be easily mounted in an already existing Rails app, but it can also be used alone.

This README is for the latest version of Monologue (0-5-stable being the latest stable version).

To learn how to upgrade, seeUPGRADE.md file. If you want to learn what changed since the last versions, seeCHANGELOG.md.

• Mailing list for questions
• Issues and bugs
• Wiki

• Rails mountable engine (fully namespaced and mountable in an already existing app)

• tested

• back to basics: few features

• tags (or categories)

• RSS

• multiple users

• support for Google Analytics and Gaug.es tags

• few external dependencies (no Devise or Sorcery, etc…) so we don't face problem integrating with existing Rails app.(Rails mountable engines: dependency nightmare?)

• comments are handled bydisqus

• more in theCHANGELOG

• Available extensions

  • monologue-markdown
  • monologue_image_upload

• seeroadmap!

gem'monologue'

And runbundle install to fetch the gem and update your 'Gemfile.lock'.

Add this to your route file (config/routes.rb)

# This line mounts Monologue's routes at the root of your application.# This means, any requests to URLs such as /my-post, will go to Monologue::PostsController.# If you would like to change where this engine is mounted, simply change the :at option to something different.## We ask that you don't use the :as option here, as Monologue relies on it being the default of "monologue"mountMonologue::Engine,at:'/'# or whatever path, be it "/blog" or "/monologue"

For example, if you decide to mount it at/blog, the admin section will be available at/blog/monologue.Here we decide to use monologue as default route mounting it at/, it means that the admin section will directlybe available at/monologue.

Run these commands:

1. $bin/rake monologue:install:migrations
2. $bin/rake db:create (only if this is a new project)
3. $bin/rake db:migrate

Open your development console withbin/rails c, then:

Monologue::User.create(name:"monologue",email:"monologue@example.com",password:"my-password",password_confirmation:"my-password")

This is all done in an initializer file, typicallyconfig/initializers/monologue.rb. More on this in theWiki - Configuration.

Start your server and go tohttp://localhost:3000/monologue to log in the admin section.

Monologue is using its own tables. If you want to use your own tables with monologue (for example the User table)this might help you tomonkey patch.

See theWiki - Customizations.

copy views like deviserails g monologue:viewsor use scope:rails g monologue:views blog

• Rails 4.2.1 +
• Database: MySQL & Postgres are supported but other databases might work too.

• Jean-Philippe Boily,@jipiboily
• Michael Sevestre,@msevestre

In the spirit offree software,everyone is encouraged to help improve this project.

Here are some waysyou can contribute:

• by using prerelease versions
• by reportingbugs
• by suggesting new features
• by writing or editing documentation
• by writing specifications
• by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
• by refactoring code
• by resolvingissues
• by reviewing patches

Starting point:

• Fork the repo
• Clone your repo
• Runbundle install
• Runbundle exec rake db:migrate
• Runbundle exec rake db:setup
• Make your changes
• Ensure specs pass by runningbundle exec rspec spec
• Submit your pull request

You will need to install this before running the test suite:

• https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit

Zurb for the "social foundicons".