river-admin 0.2.0

Administration For django-river

River Admin

:rocket: :rocket: :rocket: River Admin is a very modern and a shiny web application functioning like an admin interface that provides administration for django-river . It basically extends the django-river flexibility with some user friendly and very easy to use admin interfaces.

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

Documentation

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

Getting Started

Requirements

• django-river >= 3.0.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 is with the easiest setup.To see how to do it with django-river pleas have a look at django-river

1. Install and enable it

   pip install river-admin

   INSTALLED_APPS=[
       ...
       'river',
       'river-admin'
       ...
   ]

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

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

3. Collect statics (For production);

   python manage.py collectstatic

4. Run your application;

   python manage.py runserver 0.0.0.0:8000

5. 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

INSTALLED_APPS=[
    ...
    'river',
    'river-admin',
    'river_admin_shipping_example',
    ...
]

Issue Tracking Flow

Enable the example app and then run your application

INSTALLED_APPS=[
    ...
    'river',
    'river-admin',
    'river_admin_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.