simpleadmin

Create admin dashboards for Web / Mobile / API applications

getsimpleadmin
85
8
Ruby

SimpleAdmin

SimpleAdmin provides builder for administrative dashboards, it’s fit for Web / Mobile / API. Cloud or your own servers, depends on your choice and requirements.

All common admin dashboard tasks like content create / update / delete operations, charts, invite colleagues. It’s the self-hosted open-source version to use on own servers.

Example Application

Requirements

  • Ruby ~> 2.6.3
  • Rails ~> 5.2.1
  • PostgreSQL >= 9.3.10
  • NodeJS >= 8.16.0
  • Redis

Configuration

To improve SimpleAdmin and to better understand the most popular features, users activity, we plugged an analytical instrument. To disable it:

# config/initializers/settings.rb

Simpleadmin::Settings.enable_analytic = false

Manual Installation

simple_admin

Step 1 (Project installation)

After installing all required dependencies above, copy the repository locally

git clone [email protected]:getsimpleadmin/simpleadmin.git

Install gems, run migrations with the creation of database and seeds

bundle install && rake db:create && rake db:migrate && rake db:seed

And javascript dependencies

npm install && yarn install

Preferred port to run is 5000 because in most cases the main application is running on 3000 port

rails s -p 5000

Use default email [email protected] and password example to sign in.

Step 2 (Application integration)

To connect application you need to add API library:

If you didn’t find a library for your programming language or framework, please create an issue. After login, you’ll see the next form, to proceed, please use a secret key that you’ve created while installation API library.

img

If all right you’ll see the final step where you can choose tables to use in the admin dashboard

img

Step 3 (Set up interface)

SimpleAdmin contains two main entities to change the interface of datasets

  • Model
  • Collection and Form fields

The model may be a product on an e-commerce website or article on a blog.

img

Each model contains fields, on the image below you can see id (unique identifier) and login fields for user model.

img

You can see collection fields on the page with a list of all records

img

And form fields while creation and edit a new record

img

It’s a short description of features, to find more information use documentation

Contributing

Bug reports and pull requests are welcome on GitHub at github.com/getsimpleadmin/simpleadmin

License

The project is available as open source under the terms of the MIT License