Code Monkey home page Code Monkey logo

monologue's Introduction

Monologue

Gem Version Build Status Code Climate Coverage Status

**This is a fork of the master branch of jipiboily's blogging engine, monologue, as it existed on 11/9/2017. I will be continuing development on this project on this fork. This is a great solution for anyone who wants to run a blog on their rails apps, and it's especially helpful to have a gem for those of us who have multiple rails apps. I may port this project to Rails 5 in the future. I have disabled the tagging system for this project - it was terribly coded and experienced scalability issues when you publish more than a few blog posts (10+ second page load times). I'm not a fan of taggings in blog posts anyway, as they produce duplicated content, and I may not add this feature back. As I have time, I'll continue to refine this gem and keep it basic.

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?

Some features

missing features

Installation

1. Add the gem to your Gemfile.

gem 'monologue', :git => 'git://github.com/bw7432/monologue.git'

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

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:

Thanks to

Zurb for the "social foundicons".

monologue's People

Contributors

a-b-r-o-w-n avatar abreckner avatar anthonylewis avatar avitus avatar belug23 avatar bobnisco avatar brozturk avatar bw7432 avatar davidlbatey avatar dawnywu avatar illegalnumbers avatar intrepidd avatar jaimerson avatar jipiboily avatar jusx avatar kwbock avatar kyle-annen avatar msevestre avatar mtylty avatar nateberkopec avatar nicolasiensen avatar novemberkilo avatar oriolbcn avatar ospsuite avatar quainjn avatar swalkinshaw avatar theempty avatar thomasharper avatar weedyseadragon avatar xvonabur avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.