Getting started

Welcome to Gutter Press! This guide will walk you through cloning and setting up your own Gutter Press instance.

Requirements

Before you begin, ensure you have:

Clone Gutter Press from GitHub:

$ git clone https://github.com/BillyRuffian/gutter_press.git my-blog
$ cd my-blog

Replace my-blog with whatever you’d like to call your project.

Install Ruby gems and JavaScript packages:

$ bundle install

Create and migrate the database:

$ rails db:create
$ rails db:migrate

Use the dev script to start all services:

$ bin/dev

Visit http://localhost:3000 to see Gutter Press in action!

Gutter Press works out of the box with sensible defaults. Key configuration files:

Configure your database in config/database.yml. SQLite is the default for development:

development:
  adapter: sqlite3
  database: storage/development.sqlite3

For production, set these environment variables:

RAILS_MASTER_KEY=your-master-key
DATABASE_URL=postgres://user:pass@host/dbname

Since you own the code, you can modify anything:

Now that Gutter Press is installed, explore these guides:

Learn how to create and format beautiful content with the Lexxy editor.

Customize the look and feel of your Gutter Press installation.

Make sure you’re using bin/dev which runs the asset pipeline:

$ bin/dev

Or manually build assets:

$ rails assets:precompile

Make sure all migrations have run:

$ rails db:migrate:status

Reset the database if needed:

$ rails db:reset