README.md in pageflow-0.10.0 vs README.md in pageflow-0.11.0
- old
+ new
@@ -1,18 +1,20 @@
# Pageflow
[](http://badge.fury.io/rb/pageflow)
[](https://travis-ci.org/codevise/pageflow)
+[](https://coveralls.io/github/codevise/pageflow?branch=master)
+[](https://codeclimate.com/github/codevise/pageflow)
Multimedia story telling for the web.
For a high level introduction and example Pageflow stories see
[pageflow.io](http://pageflow.io).
-In addition to this README, there is also a [Getting Started Wiki page](https://github.com/codevise/pageflow/wiki/Getting-Started)
-to guide you through the steps of setting up a Rails application with Pageflow
-on your development machine.
+* [Getting Started](https://github.com/codevise/pageflow/wiki/Getting-Started)
+* [Guides](https://github.com/codevise/pageflow/blob/master/doc/index.md)
+* [Theme Settings](http://codevise.github.io/pageflow/theme/master/)
## Updating
For instructions on how to update from a prior version of the gem see
the
@@ -32,24 +34,23 @@
* Generators to quickly bootstrap a new Rails application
Pageflow assumes the following choice of libraries:
* [Devise](https://github.com/plataformatec/devise) for authentication
-* [CanCan](https://github.com/ryanb/cancan) for authorization
+* [CanCanCan](https://github.com/CanCanCommunity/cancancan) for authorization
* [ActiveAdmin](http://activeadmin.info/) for administration
* [Resque](https://github.com/resque/resque) for background jobs
* [FriendlyId](https://github.com/norman/friendly_id) for pretty URLs
* [Paperclip](https://github.com/thoughtbot/paperclip) for attachment handling
* [Backbone](http://backbonejs.org/) [Marionette](http://marionettejs.com/) for client side development
-
## Requirements
Pageflow runs in environments with:
-* Ruby >= 1.9.3 and < 2.2.0 because of [ActiveAdmin](https://github.com/activeadmin/activeadmin/issues/3715)
-* Rails 4.0 or 4.1
+* Ruby >= 2.1
+* Rails 4.2
* Redis server (for Resque)
* A database server supported by Active Record (tested with MySQL)
* ImageMagick
Accounts of the following cloud services have to be registered:
@@ -80,21 +81,11 @@
Add this line to your application's Gemfile:
# Gemfile
gem 'pageflow'
-At the moment, Pageflow depends on a frozen version of Active Admin
-since, back when development started, no Rails 4 compatible version of
-Active Admin was available as a gem. You therefore need to bundle the
-`rails4` branch that we have forked into our github organization:
-
- # Gemfile
- gem 'activeadmin', git: 'https://github.com/codevise/active_admin.git', branch: 'rails4'
- gem 'ransack'
- gem 'inherited_resources', '1.4.1'
- gem 'formtastic', '2.3.0'
- # Only required for Rails 4.1:
+ # Required for Rails 4.1:
gem 'state_machine', git: 'https://github.com/codevise/state_machine.git'
Run bundler to install dependencies:
$ bundle install
@@ -115,16 +106,10 @@
for more. If you'd rather not look behind the scenes for now, you can
safely read on.
### Database Migration
-_Devise migration name fix_: In some cases, the Devise generator creates
-a migration file without file extension. This needs to be fixed manually
-at the moment:
-
- $ rename 's/$/.rb/' db/migrate/*_devise_create_users
-
Now you can migrate the database.
$ rake db:migrate
Finally, you can populate the database with some example data, so
@@ -153,22 +138,11 @@
application.
## Running Pageflow
In addition to the Rails server, you need to start two Rake tasks for
-the background job processing. First, start a Resque worker which handles
-jobs from all queues:
-
- $ QUEUE=* rake resque:work
-
-Image and video processing are examples of jobs that are executes by these workers.
-
-Some jobs need to be executed repeatedly. For example, while videos are being
-encoded by Zencoder, there is a job that runs every few seconds to fetch the
-current progress. This delayed invocation of jobs is handled by the Resque
-Scheduler Rake task:
-
- $ QUEUE=* rake resque:scheduler
+the background job processing. These tasks are listed in `Procfile` which
+is generated in the project root folder by the Pageflow installer.
Consider using the [foreman gem](https://github.com/ddollar/foreman) to start all of
these processes (including the Rails server) with a single command in your
development environment.