{"id":15569363,"url":"https://github.com/javrasya/river-admin","last_synced_at":"2025-10-02T23:35:02.463Z","repository":{"id":36364427,"uuid":"222278072","full_name":"javrasya/river-admin","owner":"javrasya","description":":rocket: A shiny admin interface for django-river built with DRF, Vue \u0026 Vuetify","archived":false,"fork":false,"pushed_at":"2022-12-11T15:08:33.000Z","size":24440,"stargazers_count":95,"open_issues_count":39,"forks_count":24,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-12-13T20:51:27.052Z","etag":null,"topics":["admin","django","django-river","python","python-3","state-machine","vue","vuetify","workflow","workflow-engine","workflows"],"latest_commit_sha":null,"homepage":"https://riveradminproject.com/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/javrasya.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["javrasya"],"patreon":"javrasya","custom":"https://paypal.me/ceahmetdal","open_collective":"django-river"}},"created_at":"2019-11-17T16:32:19.000Z","updated_at":"2024-10-19T15:39:15.000Z","dependencies_parsed_at":"2023-01-17T01:31:08.832Z","dependency_job_id":null,"html_url":"https://github.com/javrasya/river-admin","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javrasya%2Friver-admin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javrasya%2Friver-admin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javrasya%2Friver-admin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javrasya%2Friver-admin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/javrasya","download_url":"https://codeload.github.com/javrasya/river-admin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230594209,"owners_count":18250581,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["admin","django","django-river","python","python-3","state-machine","vue","vuetify","workflow","workflow-engine","workflows"],"created_at":"2024-10-02T17:27:01.397Z","updated_at":"2025-10-02T23:35:00.829Z","avatar_url":"https://github.com/javrasya.png","language":"Vue","readme":".. |Build Status| image:: https://travis-ci.com/javrasya/river-admin.svg?branch=master\n    :target: https://travis-ci.com/javrasya/river-admin\n\n.. |Doc Status| image:: https://readthedocs.org/projects/river-admin/badge/?version=latest\n    :target: https://river-admin.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. |Licence| image:: https://img.shields.io/github/license/javrasya/river-admin\n    :alt: GitHub license\n    :target: https://github.com/javrasya/river-admin/blob/master/LICENSE\n\n.. |Coverage Status| image:: https://coveralls.io/repos/github/javrasya/river-admin/badge.svg?branch=master\u0026service=github\n    :target: https://coveralls.io/github/javrasya/river-admin?branch=master\n\n.. |Code Quality| image:: https://api.codacy.com/project/badge/Grade/3e7f03e8df5a488f90fb0ed93295c41b\n    :target: https://www.codacy.com/manual/javrasya/river-admin?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=javrasya/river-admin\u0026amp;utm_campaign=Badge_Grade\n\n.. |Downloads| image:: https://img.shields.io/pypi/dm/river-admin\n    :alt: PyPI - Downloads\n    \n.. |Discord| image:: https://img.shields.io/discord/651433240019599400\n    :target: https://discord.gg/22tm7wF\n    :alt: Discord\n\n.. |Logo| image:: docs/logo.svg\n    :width: 200\n\n.. |Images| image:: docs/_static/images/readme-images.gif\n\n.. |Issue Tracking Workflow Img| image:: docs/_static/images/issue-tracking-workflow.png\n\n.. |Shipping Workflow Img| image:: docs/_static/images/shipping-workflow.png\n\nRiver Admin\n===========\n\n|Build Status| |Doc Status| |Licence| |Coverage Status| |Code Quality| |Downloads| |Discord|\n\n\\:rocket\\: \\:rocket\\: \\:rocket\\: ``River Admin`` is a very modern and\na shiny customizable admin extension with user friendly and easy to use\ninterfaces for django-river_ . The power of it comes from the libraries\nit uses on both backend and frontend sides which are ``django-river``,\n``django-rest-framework`` ``Vue`` and ``Vuetify``.\n\n.. _`River Admin Website`: https://riveradminproject.com/\n.. _`Browser Support`: https://vuetifyjs.com/en/getting-started/browser-support#browser-support\n.. _`Vuetify`: https://vuetifyjs.com/en/\n.. _`django-river`: https://github.com/javrasya/django-river\n\n|Images|\n\nDonations\n=========\n\nThis is a fully open source project and it can be better with your donations.\n\nIf you are using ``River Admin`` to create a commercial product,\nplease consider becoming our `sponsor`_  , `patron`_ or donate over `PayPal`_\n\n.. _`patron`: https://www.patreon.com/javrasya\n.. _`PayPal`: https://paypal.me/ceahmetdal\n.. _`sponsor`: https://github.com/sponsors/javrasya\n\nLive Demo\n=========\n\nhttp://demo.riveradminproject.com/river-admin/\n\n- User: demo\n- Password: demo\n\nTo run demo locally;\n\n   .. code:: bash\n\n        export LOCAL_DEMO=True\n        pip install -r requirements.txt\n        python manage.py migrate\n        python manage.py bootstrap_shipping_example\n        python manage.py bootstrap_issue_tracker_example\n        python manage.py bootstrap_river_admin_demo\n        python manage.py runserver\n\nAnd then go to ``http://127.0.0.1:8000/river-admin/``\n\n**Note:** Create an admin user for yourself if you would like more access.\n\n\nDocumentation\n-------------\n\nOnline documentation is available at http://river-admin.rtfd.org/.\n\nGetting Started\n===============\n\nRequirements\n------------\n\n* `django-river`_ \u003e= 3.2.0\n* Any ``Python`` version that is supported by `django-river`_\n* Any ``Django`` version that is supported by `django-river`_\n* Any browser that is supported by `Vuetify`_ (`Browser Support`_)\n\n.. _`Browser Support`: https://vuetifyjs.com/en/getting-started/browser-support#browser-support\n.. _`Vuetify`: https://vuetifyjs.com/en/\n.. _`django-river`: https://github.com/javrasya/django-river\n\nInstallation\n------------\n\n**Note:** Before you can set up your workflow, your app\nintegration with ``django-river`` must be done.\nDon't worry it pretty trivial to set it up. To see\nhow to do it with ``django-river`` please have a\nlook at `django-river`_\n\n1. Install and enable it\n\n   .. code:: bash\n\n       pip install river-admin\n\n\n   .. code:: python\n\n       # settings.py\n\n       INSTALLED_APPS=[\n           ...\n           'river',\n           'rest_framework.authtoken',\n           'river_admin'\n           ...\n       ]\n\n       REST_FRAMEWORK = {\n           'DEFAULT_AUTHENTICATION_CLASSES': [\n               'rest_framework.authentication.BasicAuthentication',\n               'rest_framework.authentication.TokenAuthentication',\n           ],\n           'EXCEPTION_HANDLER': 'river_admin.views.exception_handler'\n       }\n\n2. Do migration;\n\n   .. code:: bash\n\n        python manage.py migrate\n\n3. Register ``River Admin`` urls in your app ``urls.py``\n\n   .. code:: python\n\n        urlpatterns = [\n            url(r'^', include(\"river_admin.urls\")),\n        ]\n\n4. Collect statics and make sure ``STATIC_URL`` is ``/static/`` **(FOR PRODUCTION WHERE DEBUG=False)**;\n\n   .. code:: bash\n\n       python manage.py collectstatic --no-input --no-post-process\n\n5. Run your application;\n\n   .. code:: bash\n\n       python manage.py runserver 0.0.0.0:8000\n\n\n6. Open it up on the browser and login with an admin user and enjoy the best way of flowing your work ever :-)\n\n   .. code:: bash\n\n       http://0.0.0.0:8000/river-admin/\n\n\nOut of the Box Examples\n-----------------------\n\n``River Admin`` comes with few examples that you can\nfiddle with and find your way easier.\n\n\n\n**Note:** Enabling them will create their tables and\nalso the necessary workflow components in\nthe DB for you. It might be good idea to try\nthem out on a development database.\n\nShipping Flow\n^^^^^^^^^^^^^\n\nEnable the example app and then run your application\n\n   .. code:: python\n\n       # settings.py\n\n       INSTALLED_APPS=[\n           ...\n           'river',\n           'rest_framework.authtoken',\n           'river_admin',\n           'examples.shipping_example',\n           ...\n       ]\n\n   .. code:: bash\n\n        python manage.py migrate\n        python manage.py bootstrap_shipping_example\n\n|Shipping Workflow Img|\n\nIssue Tracking Flow\n^^^^^^^^^^^^^^^^^^^\n\nEnable the example app and then run your application\n\n   .. code:: python\n\n       # settings.py\n\n       INSTALLED_APPS=[\n           ...\n           'river',\n           'rest_framework.authtoken',\n           'river_admin',\n           'examples.issue_tracker_example',\n           ...\n       ]\n\n   .. code:: bash\n\n        python manage.py migrate\n        python manage.py bootstrap_issue_tracker_example\n\n|Issue Tracking Workflow Img|\n\nContribute\n==========\n\nIn order to contribute, fork the repository, look at every instructions\nin CONTRIBUTE_ before you work then commit your changes and send a pull\nrequest.\n\nMake sure you add yourself to CONTRIBUTORS_.\n\n.. _CONTRIBUTE: https://github.com/javrasya/river-admin/blob/master/docs/contribute.rst\n.. _CONTRIBUTORS: https://github.com/javrasya/river-admin/blob/master/CONTRIBUTORS\n\n.. _license:\n\nLicense\n=======\n\nThis software is licensed under the `New BSD License`.\nSee the `LICENSE FILE`_ file in the top distribution directory\nfor the full license text.\n\n.. _`LICENSE FILE`: https://github.com/javrasya/river-admin/blob/master/LICENSE\n","funding_links":["https://github.com/sponsors/javrasya","https://patreon.com/javrasya","https://paypal.me/ceahmetdal","https://opencollective.com/django-river","https://www.patreon.com/javrasya"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavrasya%2Friver-admin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjavrasya%2Friver-admin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavrasya%2Friver-admin/lists"}