| # AdminJS |
|
|
| [AdminJS](https://adminjs.co/) is an automatic admin interface that 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 AdminJS generates UI which allows you (or other trusted users) to manage content. |
|
|
| Inspired by: [django admin](https://docs.djangoproject.com), [rails admin](https://github.com/sferik/rails_admin) and [active admin](https://activeadmin.info/). |
|
|
| ## Example application |
|
|
| Check out our demo application: |
|
|
| - Login: `example@adminjs.co` |
| - Password: `password` |
|
|
| https://demo.adminjs.co |
|
|
| You can also have a look at our customized AdminJS dashboard which shows various library statistics: |
|
|
| https://stats.adminjs.co |
|
|
| ## Getting started |
|
|
| - Check out the [documentation](https://docs.adminjs.co) |
| - Try the [live demo](https://demo.adminjs.co) as mentioned above |
|
|
| ## Our open source community on Discord |
|
|
| - [Join the community](https://adminjs.page.link/discord) to get help and be inspired. |
|
|
| # What kind of problems it solves |
|
|
| 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. |
|
|
| Everything works fine, but now you would like to: |
| * view all the data in the app, |
| * perform custom _business_ actions on objects in the database, |
| * bootstrap the tables with the _initial_ data, |
| * build custom report pages, |
| * allow other team members (not necessary programmers) to see what is going on in the application. |
|
|
| And all these cases can be solved by AdminJS. By adding couple of lines of code you have a running admin interface. |
|
|
| # Features |
|
|
| * CRUD any data in any resource |
| * Custom actions |
| * Form validation based on schema in your resources |
| * Full featured dashboard with widgets |
| * Custom resource decorators |
|
|
| ## Contribute |
|
|
| If you would like work on an AdminJS and develop new features please check out our [Contribution Guide](https://github.com/SoftwareBrothers/adminjs/blob/master/CONTRIBUTING.md) |
|
|
| There you can find instructions on how to run AdminJS locally for development. |
|
|
| If you're searching for tasks you can contribute to, we currently accept contributions to issues in our [Kanban Board](https://github.com/orgs/SoftwareBrothers/projects/5/views/1). |
|
|
| Any small or large contribution or any input into discussion is welcome! |
|
|
| ## License |
|
|
| AdminJS is copyrighted © 2023 rst.software. It is a free software, and may be redistributed under the terms specified in the [LICENSE](LICENSE.md) file. |
|
|
| ## About rst.software |
|
|
| <img src="https://pbs.twimg.com/profile_images/1367119173604810752/dKVlj1YY_400x400.jpg" width=150> |
|
|
| We’re an open, friendly team that helps clients from all over the world to transform their businesses and create astonishing products. |
|
|
| * We are available for [hire](https://www.rst.software/estimate-your-project). |
| * If you want to work for us - check out the [career page](https://www.rst.software/join-us). |
|
|
