README.rst

River Admin

🚀 🚀 🚀 River Admin is a very modern and a shiny customizable admin extension with user friendly and easy to use interfaces for django-river . The power of it comes from the libraries it uses on both backend and frontend sides which are django-river, django-rest-framework Vue and Vuetify.

Donations

This is a fully open source project and it can be better with your donations.

If you are using River Admin to create a commercial product, please consider becoming our sponsor , patron or donate over PayPal

Live Demo

http://demo.riveradminproject.com/river-admin/

• User: demo
• Password: demo

To run demo locally;

export LOCAL_DEMO=True
pip install -r requirements.txt
python manage.py migrate
python manage.py bootstrap_shipping_example
python manage.py bootstrap_issue_tracker_example
python manage.py bootstrap_river_admin_demo
python manage.py runserver

And then go to http://127.0.0.1:8000/river-admin/

Note: Create an admin user for yourself if you would like more access.

Documentation

Online documentation is available at http://river-admin.rtfd.org/.

Getting Started

Requirements

• django-river >= 3.2.0
• Any Python version that is supported by django-river
• Any Django version that is supported by django-river
• Any browser that is supported by Vuetify (Browser Support)

Installation

Note: Before you can set up your workflow, your app integration with django-river must be done. Don't worry it pretty trivial to set it up. To see how to do it with django-river please have a look at django-river

1. Install and enable it

   pip install river-admin

   # settings.py
   
   INSTALLED_APPS=[
       ...
       'river',
       'rest_framework.authtoken',
       'river_admin'
       ...
   ]
   
   REST_FRAMEWORK = {
       'DEFAULT_AUTHENTICATION_CLASSES': [
           'rest_framework.authentication.BasicAuthentication',
           'rest_framework.authentication.TokenAuthentication',
       ],
       'EXCEPTION_HANDLER': 'river_admin.views.exception_handler'
   }

2. Do migration;

   python manage.py migrate

3. Register River Admin urls in your app urls.py

   urlpatterns = [
       url(r'^', include("river_admin.urls")),
   ]

4. Collect statics and make sure STATIC_URL is /static/ (FOR PRODUCTION WHERE DEBUG=False);

   python manage.py collectstatic --no-input --no-post-process

5. Run your application;

   python manage.py runserver 0.0.0.0:8000

6. Open it up on the browser and login with an admin user and enjoy the best way of flowing your work ever :-)

   http://0.0.0.0:8000/river-admin/

Out of the Box Examples

River Admin comes with few examples that you can fiddle with and find your way easier.

Note: Enabling them will create their tables and also the necessary workflow components in the DB for you. It might be good idea to try them out on a development database.

Shipping Flow

Enable the example app and then run your application

# settings.py

INSTALLED_APPS=[
    ...
    'river',
    'rest_framework.authtoken',
    'river_admin',
    'examples.shipping_example',
    ...
]

python manage.py migrate
python manage.py bootstrap_shipping_example

Issue Tracking Flow

Enable the example app and then run your application

# settings.py

INSTALLED_APPS=[
    ...
    'river',
    'rest_framework.authtoken',
    'river_admin',
    'examples.issue_tracker_example',
    ...
]

python manage.py migrate
python manage.py bootstrap_issue_tracker_example

Contribute

In order to contribute, fork the repository, look at every instructions in CONTRIBUTE before you work then commit your changes and send a pull request.

Make sure you add yourself to CONTRIBUTORS.

License

This software is licensed under the New BSD License. See the LICENSE FILE file in the top distribution directory for the full license text.