maglev
WebsiteGithub
  • Introduction
  • Quick start
  • Concepts
    • Overview
    • Site
    • Theme
    • Page
    • Section
    • Setting
    • Block
  • Guides
    • Create a new section
    • Setup collections
    • Personalize the editor
    • Setup multiple languages
    • Secure the editor
    • Build a menu section
    • Render a section outside the Maglev layout
    • Use an icon library
    • Upgrades
    • Troubleshooting
  • Integrations
    • Avo
  • Pro
    • Introduction
    • Getting started
Powered by GitBook
On this page
  • Short version (1 minute installation) 😎
  • Long version 🤓

Was this helpful?

Quick start

Instructions to install the single-site version (or MIT version) of Maglev

PreviousIntroductionNextOverview

Last updated 5 months ago

Was this helpful?

Requirements: - Ruby 3+ - Ruby on Rails 8+ - Postgresql - ImageMagick - Node 20+

It also works for now with Ruby on Rails 7.x and Ruby on Rails 6 with Ruby 2.7 but we strongly suggest you to upgrade your Rails/Ruby stack.

Short version (1 minute installation) 😎

We wrote a Rails application template which will generate a brand new Ruby on Rails 8 application with Maglev already setup.

$ rails new my-awesome-site \
  -m https://raw.githubusercontent.com/maglevhq/maglev-core/master/template.rb \
  --database=postgresql \
  --skip-action-cable
  
$ cd my-awesome-site
$ bundle exec rails server

🎉 Congratulations! A random home page has been initialized with some content, check it out here:

If you want to modify the content, go to this url: . 🚀

Long version 🤓

First generate a new Ruby on Rails application. You can skip this step if you've got an existing application.

$ rails new my-awesome-site --database=postgresql --skip-action-cable
$ cd my-awesome-site
$ bundle exec rails db:create

Maglev depends on ActiveStorage for the content asset uploading. So you need to setup ActiveStorage like this:

We strongly recommend to enable the image_processing gem in your Gemfile. Please uncomment the line gem 'image_processing', '~> 1.3'

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

Add now the Maglev engine to your app Gemfile file.

Gemfile
gem 'maglevcms', '~> 1.8.0'
gem 'maglevcms-hyperui-kit', '~> 1.2.0'

Setup Maglev

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

Launch your rails app

$ bundle exec rails s

the maglev-hyperui-kit gem includes a library of marketing sections based on , a free open source tailwindcss components.

🎉 Congratulations! A random home page has been initialized with some content, check it out here:

If you want to modify the content, go to this url: . 🚀

http://localhost:3000/
http://localhost:3000/maglev/editor
hyperui
http://localhost:3000/
http://localhost:3000/maglev/editor