jipiboily/monologue

Monologue is a basic blogging engine. It is a Rails mountable engine you can mount in your already existing Rails app, or a in a new one! Enjoy.

Monologue

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.

Version

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

Upgrade and changes

To learn how to upgrade, see UPGRADE.md file. If you want to learn what changed since the last versions, see CHANGELOG.md.

Questions? Problems? Documentation?

• Mailing list for questions
• Issues and bugs
• Wiki

Some features

• 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 by disqus

• more in the CHANGELOG

• Available extensions

  • monologue-markdown
  • monologue_image_upload

missing features

• see roadmap!

Installation

1. Add the gem to your Gemfile.

gem 'monologue'

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

2. Route to Monologue

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"
mount Monologue::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 directly be available at /monologue.

3. Migrate Monologue's database tables

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

4. Create a user

Open your development console with bin/rails c, then:

Monologue::User.create(name: "monologue", email:"[email protected]", password:"my-password", password_confirmation: "my-password")

5. Configure Monologue.

This is all done in an initializer file, typically config/initializers/monologue.rb. More on this in the Wiki - Configuration.

6. Ready

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

Note to users

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 to monkey patch.

Customization

See the Wiki - Customizations.

Copy views

copy views like devise rails g monologue:views or use scope: rails g monologue:views blog

Requirements

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

Authors

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

Contributing

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

Here are some ways you can contribute:

• by using prerelease versions
• by reporting bugs
• 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 resolving issues
• by reviewing patches

Starting point:

• Fork the repo
• Clone your repo
• Run bundle install
• Run bundle exec rake db:migrate
• Run bundle exec rake db:setup
• Make your changes
• Ensure specs pass by running bundle 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

Thanks to

Zurb for the "social foundicons".

monologue's Issues

cache request spec should pass

It currently fails and should be using new factories

Settings in the database ?

cache

Configurations

• web site title
• web site url
• meta description
• social accounts (facebook, twitter, LinkedIn, etc)
• API keys for social sharing
• DISQUS API key

search engine

social sharing (plugin?)

Categories / tags

number of posts per page should be a setting

Factories à refactorer

500 page

Permalink generation

Based on title

Sitemap

bug: csrf token should not be cached

Forcer HTTPS pour l'admin

cache: do not clean cache when saving a not yet published post

recent article widget

Deleting a post should be possible

i18n

show published status in list of monologues

There should be a way to see which posts are drafts and which ones are posts: http://cl.ly/0t04151o041W0Y2n3q34

Twitter Bootstrapped admin

Revoir le fonctionnement des revisions nested...pas clean pour "new"

C'est pas beau ça:

    params[:post][:posts_revisions_attributes] = {}
    params[:post][:posts_revisions_attributes][0] = params[:post][:posts_revision]
    params[:post].delete("posts_revision")
    @post = Monologue::Post.new(params[:post])

Date picker

recent tweet widget

Add DISQUS count on index

http://docs.disqus.com/developers/universal/

cache: does not delete index.html at root when mounted at root

CKeditor

Markdown editor

Maybe as an extension?

ckeditor doesn't work on Heroku

Travis CI setup

first, remove the dummy app from repo then add monologue to be tested on travis

Login screen: button is not styled correctly

Only need to add a class or two

Google Analtyics

Have a setting for GA key and add script to base template

Twitter Bootstrapped admin

bug: public directory is removed by sweeper

When the app is mounted at root, "/", it seems like the sweeper is completely removing "public" directory!!!

Rails 3.2

It works with Rails 3.2, but could make the dummy app a 3.2 to help me on dev environment.

Suggest another article once the end have been reached

• use jQuery Waypoints to suggest another article (might be chosen from and?) once the article is read.
  • An example: See the "recommended story" once you reach the bottom of article

404 page

Comments (plugin?)

Pagination

easy contact form

... for an about page

404 errors

meta descriptions and keywords

move admin_path to "/monologue"

To make it possible to have multiple engine mounted at the same place, say "/", they must have different admin paths.

Keywords

RSS

add 20px top margin or so

to main container

work on mass-assignment things

3.2.3 Rails app now have:

config.active_record.whitelist_attributes = false

Anyway, I should white list fields and slice params with the slice pattern.

Repasser les TODOs avant sortie

Preview mode

Frontend theme

archive page

list all posts month by month, year by year