https://github.com/moeki0/micro-admin
A minimal Administration dashboard parts.
https://github.com/moeki0/micro-admin
admin admin-dashboard gem ruby ruby-on-rails
Last synced: 2 months ago
JSON representation
A minimal Administration dashboard parts.
- Host: GitHub
- URL: https://github.com/moeki0/micro-admin
- Owner: moeki0
- Created: 2022-10-29T23:51:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-31T13:15:41.000Z (over 3 years ago)
- Last Synced: 2025-11-30T03:50:25.301Z (7 months ago)
- Topics: admin, admin-dashboard, gem, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MicroAdmin
A Minimal Administration dashboard parts.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'micro_admin'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install micro_admin
## Usage
```ruby
class ApplicationDashboard < MicroAdmin::Dashboard::Base
# example:
self.view_paths = [Rails.root.join("app", "views", "dashboards")]
self.url_base = "/admin"
end
```
```ruby
class UserDashboard < ApplicationDashboard
def index_attributes
[:id, :name]
end
def show_attributes
[:id, :name]
end
def form_attributes
[:name]
end
def model_class
User
end
end
```
Setup routing.
```ruby
namespace :admin do
resources :users
end
```
`/app/views/dashboards/user_dashboard/new/name.erb`:
```html
```
`/app/views/dashboards/user_dashboard/edit/name.erb`:
`value` is available.s
```html
```
```ruby
smith = User.new(id: 1, name: "Smith")
james = User.new(id: 1, name: "James")
dashboard = UserDashboard.new
```
```erb
<%= dashboard.index([smith, james]) %>
```
output:
```html
User
id
name
show
edit
1
Smith
show
edit
2
James
show
edit
```
```erb
<%= dashboard.show(smith) %>
```
output:
```html
Show User
- id>
- 1
- name
- Smith
```
```erb
<%= dashboard.new(errors: ["Name is required!"]) %>
```
output:
```html
Create User
- Name is required
name
```
```erb
<%= dashboard.edit(id: 1, values: {name: "Smith"}, errors: []) %>
```
output:
```html
Create User
name
```
**You can decorate table and forms with [Bootstrap](https://getbootstrap.com/docs/5.0/getting-started/download/)!**
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/cc-kawakami/micro_admin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Code of Conduct
Everyone interacting in the MicroAdmin project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cc-kawakami/micro_admin/blob/master/CODE_OF_CONDUCT.md).