Quick start

The fastest way to get up and running with Adminly is to follow the onboarding guide on Adminly.com.

For developers that want to quickly integrate and self-host Adminly, please continue.

This quick start guide is intended for developers who wish to self-host adminly into an existing application. This requires Ruby on Rails 6+ and a relational database.

Installation

Add adminly gem to bundler:

gem 'adminly'

Install adminly:

$ bundle install

Add Adminly routes to your config/routes.rb file:

mount Adminly::Engine, at: "/adminly"

Add your JWT_SECRET and DATABASE_URL to your .env file.

Create a file config/adminly.rb and copy paste the following code:

Adminly.tap do |config|
    config.jwt_secret = ENV['JWT_SECRET']
end 

Restart your rails server and navigate to the endpoint to confirm it's working:

rails s