Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CultivateLabs/storytime
Storytime is a Rails 4+ CMS and blogging engine, with a core focus on content. It is built and maintained by @cultivatelabs
https://github.com/CultivateLabs/storytime
Last synced: about 1 month ago
JSON representation
Storytime is a Rails 4+ CMS and blogging engine, with a core focus on content. It is built and maintained by @cultivatelabs
- Host: GitHub
- URL: https://github.com/CultivateLabs/storytime
- Owner: CultivateLabs
- License: mit
- Created: 2014-05-08T19:09:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-03-10T15:37:09.000Z (almost 2 years ago)
- Last Synced: 2024-09-27T09:18:53.719Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 6.21 MB
- Stars: 752
- Watchers: 37
- Forks: 81
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
- awesome-ruby - Storytime - Rails 4+ CMS and bloging engine, with a core focus on content. (CMS)
- Open-Source-Ruby-and-Rails-Apps - Storytime - Storytime is a Rails 4+ CMS and blogging engine, with a core focus on content. 🔥 ✅ (Happy Exploring 🤘)
README
[](https://circleci.com/gh/CultivateLabs/storytime/tree/master)
Storytime is a Rails 4+ CMS and blogging engine, with a core focus on content. It is built and maintained by [CultivateLabs](https://www.cultivatelabs.com/?utm_source=github&utm_medium=readme&utm_campaign=github) / [@cultivatelabs](http://twitter.com/cultivatelabs)
## Features
* [Simple integration with Rails 4+ apps](https://github.com/CultivateLabs/storytime/wiki/Setup) - Quickly get set up using a guided, automated, or manual setup experience, whatever suits your fancy.
* [Quick access dashboard](https://github.com/CultivateLabs/storytime/wiki/Using-the-Quick-Access-Menu) - Access Storytime's dashboard from anywhere on your site with our quick access menu.
* [Multi-site support](https://github.com/CultivateLabs/storytime/wiki/Multi-site-Support) - Manage multiple sites with one Storytime deployment.
* [Inline text snippet editing](https://github.com/CultivateLabs/storytime/wiki/Text-Snippets) - Create and edit snippets of content that can be re-used throughout your Storytime site.
* [Admin of other Rails models](https://github.com/CultivateLabs/storytime/wiki/Admin-of-Rails-Models) - Manage your models from the Storytime dashboard.
* [Custom Post Types](https://github.com/CultivateLabs/storytime/wiki/Using-Custom-Post-Types) - Add custom post types to alter functionality or appearance of posts.
* [Email list building](https://github.com/CultivateLabs/storytime/wiki/Email-Subscriptions) - Collect and manage emails using a simple view helper.
* [New post notifications](https://github.com/CultivateLabs/storytime/wiki/Working-with-New-Post-Notifications) - Send notifications to your site's subscribers whenever you publish a post.
* [Built-in search](https://github.com/CultivateLabs/storytime/wiki/Using-Storytime%27s-Post-Search) - Easily search through Storytime's posts using built-in search adapters or request parameters.
## Separation of Concerns
Storytime is built around several opinions regarding the responsibilities and concerns of the CMS and the host app.
Storytime is responsible for:
* Editing **content**, **copy**, and very **basic formatting** (basic formatting roughly = things you could do in markdown)
* Enabling customization, extension, and theming
* Basic CRUD administration of other Rails models
Host app is responsible for:
* Complex page structure (HTML), styling (CSS), and interactions (JavaScript)
* App-specific details or customizations (e.g. Storytime tells the host app to send a post notification email, host app decides how to send the email, whether it should be in a background job, etc.)
* Presentation details -- we like to think of the host app as providing the "theme" for the Storytime site.
This separation is intended to provide several benefits and/or solve several problems:
* *Problem:* Building complex page structure and styling inside the CMS prevents the code from going into version control
* *Problem:* If complex page structure is in the CMS, it becomes much easier to break on production sites.
* *Benefit:* If complex page structure stays in the host app and CMS users just edit content/copy, code goes into version control and pages are much less likely to break.
* *Benefit:* Combining admin and CMS/blog features in one place gives site administrators **a single place to edit content** (rather than requiring both a CMS/blog and something like ActiveAdmin or RailsAdmin).
## Sample App
[](https://heroku.com/deploy?template=https://github.com/CultivateLabs/storytime-example/blob/master)
## Installation
Add Storytime to your Gemfile:
```ruby
gem "storytime"
```
Run the bundle command to install it.
After you install Storytime and add it to your Gemfile, you can either setup Storytime through a [guided command line interface](#guided-setup), a speedy [automated setup](#automated-setup), or [manually](#manual-setup).
**Note:** To use the image upload feature, Storytime requires you to have Imagemagick installed on your system.
### Guided Setup
Storytime can set up your routes file, initializer, user model, copy migrations, migrate your database, and copy views into your app through a simple command line interface (CLI). In order to use the CLI, first create a binstub of Storytime by running the following command:
```terminal
$ bundle binstub storytime
```
After creating the binstub just run the following command to get started with the guided setup:
```terminal
$ storytime install
```
After answering the prompts, fire up your Rails server and access the Storytime dashboard, by default located at `http://localhost:3000/storytime`.
### Automated Setup
The automated setup goes through all of the steps in the [Guided Setup](#guided-setup), but instead of prompting you for values it just uses all the defaults, allowing you to setup Storytime in seconds.
In order to use the automated setup, first create a binstub of Storytime (see [Guided Setup](#guided-setup)). Next, run the install command with the -d option:
```terminal
$ storytime install -d
```
After the setup is complete, fire up your Rails server and access the Storytime dashboard, by default located at `http://localhost:3000/storytime`.
### Manual Setup
Manual setup of Storytime assumes that your host app has an authentication system, like [Devise](https://github.com/plataformatec/devise), already installed. *Before proceeding make sure you have properly set up Devise.*
After you install Storytime and add it to your Gemfile, you should run the install generator:
```terminal
$ rails generate storytime:install
```
The install generator will create a Storytime initializer containing various configuration options. Be sure to review and update the generated initializer file as necessary.
Running the install generator will also insert a line into your routes file responsible for mounting the Storytime engine.
By default, Storytime is mounted at `/`. If you want to keep that mount point make sure that the Storytime mount is the **last** entry in your routes file:
```ruby
mount Storytime::Engine => "/"
```
Install migrations:
```ruby
rake storytime:install:migrations
rake db:migrate
```
Add `storytime_user` to your user class:
```ruby
class User < ActiveRecord::Base
devise :database_authenticatable, :registerable,
:recoverable, :rememberable, :trackable, :validatable
storytime_user
end
```
Finally, fire up your Rails server and access the Storytime dashboard, by default located at `http://localhost:3000/storytime`.
*Optional:* While not necessary, you may want to copy over the non-dashboard Storytime views to your app for customization:
```console
$ rails generate storytime:views
```
## Getting Started
See the [Storytime Wiki](https://github.com/CultivateLabs/storytime/wiki) for more documentation and information on using Storytime's various features.
## Screen Shots
Page List:
Post Editor:
Admin of Custom Rails Models:
Text Snippets:
User Management:
Site Settings:
Media Uploads:
## Copyright
Copyright © 2014-2015 CultivateLabs Inc. Storytime is released under the [MIT-LICENSE](MIT-LICENSE).