Add Uchi to your application

After having installed the gem to your application (See installation instructions) you are ready to configure Uchi.

Mount Uchi in your application

Add to config/routes.rb:

  Uchi.routes.mount(self)

Add a repository for one of your models

Assuming you have a Customer model with an id and a name attribute, add the following in app/uchi/repositories/customer.rb:

module Uchi
  module Repositories
    class Customer < Repository
      def fields
        [
          Field::Number.new(:id),
          Field::Text.new(:name),
        ]
      end
    end
  end
end

You can learn more about Uchi Repositories in the Repositories documentation.

Create a controller to handle requests

In app/controllers/uchi/customers_controller.rb:

module Uchi
  class CustomersController < Uchi::RepositoryController
  end
end

Now start your Rails server and visit http://localhost:3000/uchi/customers. Welcome to Uchi 😁

Mounting at a Custom Path

By default, Uchi is mounted at /uchi. To use a different path:

Rails.application.routes.draw do
  Uchi.routes.mount(self, at: "admin")

  namespace :admin do
    # Your other admin routes
  end
end

Now Uchi will be available at /admin instead of /uchi.