javrasya/river-admin — 92 Stars

Topics

#admin #django #django-river #python #python-3 #state-machine #vue #vuetify #workflow #workflow-engine #workflows

Language breakdown

Vue 42.0%

SCSS 22.1%

Python 21.3%

JavaScript 13.8%

HTML 0.7%

Shell 0.2%

▸ Files click to expand

README

.. |Build Status| image:: https://travis-ci.com/javrasya/river-admin.svg?branch=master :target: https://travis-ci.com/javrasya/river-admin

.. |Doc Status| image:: https://readthedocs.org/projects/river-admin/badge/?version=latest :target: https://river-admin.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. |Licence| image:: https://img.shields.io/github/license/javrasya/river-admin :alt: GitHub license :target: https://github.com/javrasya/river-admin/blob/master/LICENSE

.. |Coverage Status| image:: https://coveralls.io/repos/github/javrasya/river-admin/badge.svg?branch=master&service=github :target: https://coveralls.io/github/javrasya/river-admin?branch=master

.. |Code Quality| image:: https://api.codacy.com/project/badge/Grade/3e7f03e8df5a488f90fb0ed93295c41b :target: https://www.codacy.com/manual/javrasya/river-admin?utmsource=github.com&utmmedium=referral&utmcontent=javrasya/river-admin&utmcampaign=Badge_Grade

.. |Downloads| image:: https://img.shields.io/pypi/dm/river-admin :alt: PyPI - Downloads .. |Discord| image:: https://img.shields.io/discord/651433240019599400 :target: https://discord.gg/22tm7wF :alt: Discord

.. |Logo| image:: docs/logo.svg :width: 200

.. |Images| image:: docs/_static/images/readme-images.gif

.. |Issue Tracking Workflow Img| image:: docs/_static/images/issue-tracking-workflow.png

.. |Shipping Workflow Img| image:: docs/_static/images/shipping-workflow.png

River Admin ===========

\:rocket\: \:rocket\: \:rocket\: `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.

.. _River Admin Website: https://riveradminproject.com/ .. _Browser Support: https://vuetifyjs.com/en/getting-started/browser-support#browser-support .. _Vuetify: https://vuetifyjs.com/en/ .. _django-river: https://github.com/javrasya/django-river


|Images|
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_

.. _patron: https://www.patreon.com/javrasya .. _PayPal: https://paypal.me/ceahmetdal .. _sponsor: https://github.com/sponsors/javrasya


Live Demo =========
http://demo.riveradminproject.com/river-admin/
User: demo
Password: demo

To run demo locally;
.. code:: bash
export LOCAL_DEMO=True         pip install -r requirements.txt         python manage.py migrate         python manage.py bootstrapshippingexample         python manage.py bootstrapissuetracker_example         python manage.py bootstrapriveradmin_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)


.. _

Browser Support

: https://vuetifyjs.com/en/getting-started/browser-support#browser-support
.. _

Vuetify

: https://vuetifyjs.com/en/
.. _

django-river

: https://github.com/javrasya/django-river
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_


Install and enable it

   .. code:: bash
pip install river-admin
.. code:: python
# settings.py
INSTALLED_APPS=[            ...            'river',            'rest_framework.authtoken',            'river_admin'            ...        ]
REST_FRAMEWORK = {            'DEFAULTAUTHENTICATIONCLASSES': [                'rest_framework.authentication.BasicAuthentication',                'rest_framework.authentication.TokenAuthentication',            ],            'EXCEPTIONHANDLER': 'riveradmin.views.exception_handler'        }
Do migration;

   .. code:: bash
python manage.py migrate

Register River Admin urls in your app urls.py


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

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


   .. code:: bash
python manage.py collectstatic --no-input --no-post-process
Run your application;

   .. code:: bash
python manage.py runserver 0.0.0.0:8000
Open it up on the browser and login with an admin user and enjoy the best way of flowing your work ever :-)

   .. code:: bash
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
.. code:: python
# settings.py
INSTALLED_APPS=[            ...            'river',            'rest_framework.authtoken',            'river_admin',            'examples.shipping_example',            ...        ]
.. code:: bash
python manage.py migrate         python manage.py bootstrapshippingexample
|Shipping Workflow Img|
Issue Tracking Flow ^^^^^^^^^^^^^^^^^^^
Enable the example app and then run your application
.. code:: python
# settings.py
INSTALLED_APPS=[            ...            'river',            'rest_framework.authtoken',            'river_admin',            'examples.issuetrackerexample',            ...        ]
.. code:: bash
python manage.py migrate         python manage.py bootstrapissuetracker_example
|Issue Tracking Workflow Img|
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_.
.. _CONTRIBUTE: https://github.com/javrasya/river-admin/blob/master/docs/contribute.rst .. _CONTRIBUTORS: https://github.com/javrasya/river-admin/blob/master/CONTRIBUTORS
.. _license:
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.

.. _LICENSE FILE`: https://github.com/javrasya/river-admin/blob/master/LICENSE

🔗 More in this category