Hotsheet

Manage your Rails database through a spreadsheet-like interface.

• Look at and modify your DB within the app itself (no rails console required!).
• Give controlled DB access to your admin users without having to create CRUD views for each table.
• Lightweight and fast. We keep usage simple and configuration to the minimum.

Installation

1. Add gem "hotsheet" to your Gemfile.
2. Run bundle.
3. Run bin/rails g hotsheet:install.

Usage

After the installation, you can start the Rails server and visit /hotsheet to view the spreadsheet.

Configuration

You can configure which models ('sheets') this gem should manage, and specify which database columns should be editable or viewable in the spreadsheet. This can be done by editing the config/initializers/hotsheet.rb file created by the install command:

Hotsheet.configure do
  # Configure the visible and editable columns for each model.
  # The ID is included as the first column by default.
  # The number of rows displayed can be configured using the `per` option,
  # which defaults to 100.

  sheet :User, per: 10 do
    column :name
    column :email, editable: false
    column :birthdate, editable: -> { rand > 0.5 }
  end

  # Leave the block out to include all database columns.
  sheet :Post

  # Pass a `scope` (a lambda evaluated on the model) to restrict the rows.
  # When the same model is used more than once, give each sheet a unique
  # name with `as:`; it is used in the URL and the navigation.
  sheet :User, scope: -> { where(admin: true) }, as: :admins do
    column :name
    column :email
  end
end

Basic Authentication

If you don't want everyone to have access to Hotsheet, you can set a basic auth environment variable:

HOTSHEET_BASIC_AUTH="admin:password"

Internationalization

You can create custom translations by overwriting the default locales defined in config/locales/en.yml.

Contributing

See Contributing Guide and please follow the Code of Conduct.

Roadmap

This is a newly created gem, and we will firstly focus on:

1. Single-user experience (styles and usability)
2. Configuration and access permissions
3. Concurrent users (broadcasting, conflict resolution)

Feel free to look at our planned enhancements or add your own.

License

Hotsheet is available as open source under the terms of the MIT License.
Copyright © 2024-present Renuo AG.