# Get Started

Avo is a beautiful next-generation framework that empowers developers and teams to deliver fast and in a uniform way beautiful admin panels for your Ruby on Rails apps.

It's built with Hotwire so it speaks your favorite language, Ruby on Rails.

Avo is a Ruby on Rails engine that runs isolated side by side with your app. It knows how to read and write the data you want to access.

Avo is a separate Rails engine

# Overview of Avo

In the future we want Avo to be the central place where you do your work like manage resources, update app settings, view stats and dashboards and, bring your own functionality. At the moment, the primary goal of Avo is to administer your database records. To do that, it uses the concept of a Resource. Each Avo Resource corresponds to a Rails Model.

The next step after you define your Resource is to map the database fields, so Avo knows what data to display from the database and how to display it. Each field declaration adds a column of data into the Index view and, a row in the Show, Edit, and Create views.

There are the basic fields like text, textarea, select and boolean, and the more complex ones like trix, markdown, gravatar, and boolean_group. There's even an amazing file field that's tightly integrated with Active Storage. You've never added files integration as easy as this before.

After you've set up your resources with the desired fields, you may want to filter them based on certain conditions. You can easily do that with Avo filters. You just generate the filter, set up the desired options and, add it to one or more resources.

Similarly, Avo makes it easy to apply transformations to one or more resources using Actions. Actions can run by themselves or have configured fields that take your input before they run.

# Seamless upgrades

Avo comes packaged as a gem. It does not pollute your app with its internal files. Instead, everything is tucked away neatly in the package.

That makes for a wonderful upgrade experience. You hit bundle update avo, and you get the newest and best of Avo without any file conflicts.

# Next up

Now that you know the basics, you can:

  1. Install Avo in your app
  2. Set up the current user
  3. Create a Resource
  4. Set up authorization
  5. Set up licensing
  6. Explore the live demo app (opens new window)
  7. Explore these docs
  8. Enjoy building your app without ever worrying about the admin again
  9. Explore the FAQ pages for guides on how to set up your Avo instance.