Quickstart

Install the open source (single-site) edition of Maglev v3 in a Ruby on Rails application.

This guide covers two paths: a Rails application template (fastest for a greenfield app) or manual setup (better when adding Maglev to an app you already have).

Option A — Rails template (about a minute)

The official template creates a new Rails 8 application with Maglev and the HyperUI-based section library preconfigured.

rails new my-awesome-site \
  -m https://raw.githubusercontent.com/maglevhq/maglev-core/master/template.rb \
  --skip-action-cable

cd my-awesome-site
bundle exec rails server

When the server is running, open the site at http://localhost:3000/. A sample home page is created for you.

To edit pages in the visual builder, use http://localhost:3000/maglev/editor.

Option B — Manual setup (new or existing Rails app)

Use this path if you prefer full control or are adding Maglev to an existing project.

1. Rails app and database

Create a new app (skip this if you already have one):

rails new my-awesome-site --skip-action-cable
cd my-awesome-site
bundle exec rails db:create

2. Active Storage

Maglev uses Active Storage for media uploads. Install and migrate:

bundle exec rails active_storage:install
bundle exec rails db:migrate

3. Gems

Add Maglev and the HyperUI kit to your Gemfile, then install:

Gemfile
gem 'maglevcms', '~> 3.0.0'
gem 'maglevcms-hyperui-kit', '~> 2.0.0'

bundle install

4. Generators and site record

bundle exec rails g maglev:install
bundle exec rails g maglev:hyperui:install --force
bundle exec rails maglev:create_site
bundle exec rails maglev:publish_site

5. Run the app

bundle exec rails server

Visit http://localhost:3000/ for the preview site and http://localhost:3000/maglev/editor for the editor—the same as in Option A.