Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getsimpleadmin/simpleadmin
Create admin dashboards for Web / Mobile / API applications
https://github.com/getsimpleadmin/simpleadmin
rails ruby webdevelopment webservice
Last synced: 2 months ago
JSON representation
Create admin dashboards for Web / Mobile / API applications
- Host: GitHub
- URL: https://github.com/getsimpleadmin/simpleadmin
- Owner: getsimpleadmin
- Created: 2017-09-26T11:28:58.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T11:22:42.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T07:21:04.992Z (3 months ago)
- Topics: rails, ruby, webdevelopment, webservice
- Language: Ruby
- Homepage: https://getsimpleadmin.com
- Size: 2.48 MB
- Stars: 89
- Watchers: 5
- Forks: 8
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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][demo]
## Requirements
- [Ruby ~> 2.6.3][ruby]
- 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:
```ruby
# config/initializers/settings.rb
Simpleadmin::Settings.enable_analytic = false
```
## Manual Installation
## 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:
- [Ruby][simpleadminruby]
- [Node.js][simpleadminnodejs]
If you didn't find a library for your programming language or framework, please [create an issue][newissue]. After login, you'll see the next form, to proceed, please use a secret key that you've created while installation API library.
If all right you'll see the final step where you can choose tables to use in the admin dashboard
## 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.
Each model contains fields, on the image below you can see id (unique identifier) and login fields for user model.
You can see **collection fields** on the page with a list of all records
And **form fields** while creation and edit a new record
It's a short description of features, to find more information use [documentation](https://getsimpleadmin.com/documentation)
## Contributing
Bug reports and pull requests are welcome on GitHub at [github.com/getsimpleadmin/simpleadmin](https://github.com/getsimpleadmin/simpleadmin)
## License
The project is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT)
[demo]: https://getsimpleadmin.com/demo/admin/customer/resources
[simpleadminruby]: https://github.com/getsimpleadmin/simpleadmin-ruby
[simpleadminnodejs]: https://github.com/getsimpleadmin/simpleadmin-nodejs
[newissue]: https://github.com/getsimpleadmin/simpleadmin/issues/new
[ruby]: https://rvm.io/rvm/install