| 1 | # Admin Bro
|
| 2 |
|
| 3 | [](https://codecov.io/gh/SoftwareBrothers/admin-bro)
|
| 4 | [](https://travis-ci.com/SoftwareBrothers/admin-bro)
|
| 5 |
|
| 6 | [AdminBro](https://softwarebrothers.github.io/admin-bro-dev/) is An automatic admin interface which can be plugged into your application. You, as a developer, provide database models (like posts, comments, stores, products or whatever else your application uses), and AdminBro generates UI which allows you (or other trusted users) to manage content.
|
| 7 |
|
| 8 | Inspired by: [django admin](https://docs.djangoproject.com), [rails admin](https://github.com/sferik/rails_admin) and [active admin](https://activeadmin.info/).
|
| 9 |
|
| 10 | ## How it looks
|
| 11 |
|
| 12 | <img src='./docs/anim.gif'>
|
| 13 |
|
| 14 | ## Example application
|
| 15 |
|
| 16 | Check out the example application with mongodb and postgres models here:
|
| 17 |
|
| 18 | - login: `test@example.com`
|
| 19 | - password: `password`
|
| 20 |
|
| 21 | https://admin-bro-example-app.herokuapp.com/admin
|
| 22 |
|
| 23 | ## Getting Started
|
| 24 |
|
| 25 | - Check out the [documentation](https://softwarebrothers.github.io/admin-bro-dev/)
|
| 26 | - Try the [live demo](https://admin-bro-example-app.herokuapp.com/admin) as mentioned above
|
| 27 |
|
| 28 | # What kind of problems it solves
|
| 29 |
|
| 30 | So you have a working service built in Node.js. It uses (for example) [Hapi.js](https://hapijs.com/) for rendering a couple of REST routes and [mongoose](https://mongoosejs.com/) as the _connector_ to the database.
|
| 31 |
|
| 32 | Everything works fine, but now you would like to:
|
| 33 | * see all the data in the app,
|
| 34 | * perform custom _business_ actions on objects in the database,
|
| 35 | * bootstrap the tables with the _initial_ data,
|
| 36 | * build custom report pages,
|
| 37 | * allow other team members (not necessary programmers) to see what is going on in the application.
|
| 38 |
|
| 39 | And all these cases can be solved by AdminBro. By adding couple of lines of code you have a running admin interface.
|
| 40 |
|
| 41 | # Features
|
| 42 |
|
| 43 | * CRUD any data in any resource
|
| 44 | * Custom actions
|
| 45 | * Form validation based on schema in your resources
|
| 46 | * Full featured dashboard with widgets
|
| 47 | * Custom resource decorators
|
| 48 |
|
| 49 | ## Contribute
|
| 50 |
|
| 51 | If you would like work on an admin-bro and develop new features - take a look at our dev repository: https://github.com/SoftwareBrothers/admin-bro-dev
|
| 52 |
|
| 53 | You can find there instructions on how to run admin-bro for development.
|
| 54 |
|
| 55 | ## License
|
| 56 |
|
| 57 | AdminBro is Copyright © 2018 SoftwareBrothers.co. It is free software, and may be redistributed under the terms specified in the [LICENSE](LICENSE.md) file.
|
| 58 |
|
| 59 | ## About SoftwareBrothers.co
|
| 60 |
|
| 61 | <img src="https://softwarebrothers.co/assets/images/software-brothers-logo-full.svg" width=240>
|
| 62 |
|
| 63 | We’re an open, friendly team that helps clients from all over the world to transform their businesses and create astonishing products.
|
| 64 |
|
| 65 | * We are available to [hire](https://softwarebrothers.co/contact).
|
| 66 | * If you want to work for us - checkout the [career page](https://softwarebrothers.co/career).
|