Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cmdbrew/adminterface

A gem that brings Bootstrap 5, advanced customizability, and other goodies into ActiveAdmin
https://github.com/cmdbrew/adminterface

activeadmin activeadmin-plugin activeadmin-themes rails ruby

Last synced: 5 days ago
JSON representation

A gem that brings Bootstrap 5, advanced customizability, and other goodies into ActiveAdmin

Awesome Lists containing this project

README

        

> ## ⛔️ DEPRECATED: THIS GEM IS NO LONGER BEING MAINTAINED
> Due to personal reasons, we can no longer continue to maintain this gem. As a result, we are no longer accepting or merging pull requests.
>
> To help with the transition, we've changed the license to MIT and removed the license verification for commercial uses. For alternatives, please check out other excellent solutions listed in the [ActiveAdmin Wiki](https://github.com/activeadmin/activeadmin/wiki).
>
> Thank you to all who contributed and who used Adminterface in their projects. We couldn't have made it this far without your support.
>
> Until next time.
>
> — I-Lung, Richard Wang, and the Adminterface team

# Adminterface
[![CI](https://github.com/CMDBrew/adminterface/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/CMDBrew/adminterface/actions/workflows/ci.yml)
[![Maintainability](https://api.codeclimate.com/v1/badges/4dbedfdf21a2d675d2ca/maintainability)](https://codeclimate.com/github/CMDBrew/adminterface/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/4dbedfdf21a2d675d2ca/test_coverage)](https://codeclimate.com/github/CMDBrew/adminterface/test_coverage)
[![gem](https://img.shields.io/gem/v/adminterface?color=%23E9573F&label=rubygems.org)](https://rubygems.org/gems/adminterface)
[![npm](https://img.shields.io/npm/v/@cmdbrew/adminterface?color=%230273B4&label=npmjs.com)](https://www.npmjs.com/package/@cmdbrew/adminterface)

A gem that brings Bootstrap 5, advanced customizability, and other goodies into ActiveAdmin

[![](preview.jpg)](https://adminterface.io)

## Dependencies
- [Ruby](https://www.ruby-lang.org/en/) >= 2.7
- [Rails](http://rubyonrails.org/) >= 6.0
- [ActiveAdmin](https://github.com/activeadmin/activeadmin) ~> 2.9
- [Bootstrap](https://getbootstrap.com/) ~> 5.1.3
- [Webpacker](https://github.com/rails/webpacker) ~> 5.0

## Get Started
- [Documentation](https://adminterface.io/docs/intro)
- [Demo](https://demo.adminterface.io)
- [Issue tracker](https://github.com/CMDBrew/adminterface/issues)
- [Discussions and feature requests](https://github.com/CMDBrew/adminterface/discussions)

## Installation
1. Add the following to your application's Gemfile:
```ruby
gem "adminterface"
```
2. Then execute:
```bash
$ bundle install
```
3. Install ActiveAdmin (If you haven't)
```bash
$ rails g active_admin:install --use_webpacker
```
4. Install Adminterface

> This command will ask for permissions to overwrite files generated by ActiveAdmin. Make sure to review the files carefully and accept them.
> We recommend you commit your files before running this command to ensure you are aware of the changes made.

```bash
$ rails g adminterface:install
```
5. Migrate your database and start the server
```bash
$ rails db:migrate
$ rails server
```

## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).

## License
The gem is available as open source under the terms of the [MIT License](LICENSE.md).