Skip to content
🚀 A shiny admin interface for django-river built with DRF, Vue & Vuetify
Vue CSS Python JavaScript Other
Branch: master
Clone or download

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.git-crypt Add 1 git-crypt collaborator Nov 24, 2019
.github Update issue templates Dec 11, 2019
demo Bind demo heroku app to a subdomain under riveradminproject.com Nov 29, 2019
docs ⬆️ Bump version Dec 11, 2019
examples Clean workflow components of the examples before bootstrapping for cl… Nov 28, 2019
pages ⬆️ Bump version Dec 11, 2019
public Fix asset paths after build Nov 26, 2019
river_admin [#5] Build after fix the vulnerability with serialize-javascript Dec 11, 2019
ui [#1] Show state descriptions in a tooltip when hovering the states in… Nov 28, 2019
.codacy.yml Ignore md files on code quality checking Dec 11, 2019
.coveragerc Fix asset paths after build Nov 26, 2019
.coveralls.yml Integrate to Coveralls Nov 24, 2019
.eslintrc Restructure the folder Nov 24, 2019
.gitattributes Use db credentials from heroku config Nov 26, 2019
.gitignore Run tests with Django3.0 as well Feb 6, 2020
.pypirc Fix pypirc file Dec 11, 2019
.travis.yml Run tests with Django3.0 as well Feb 6, 2020
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Dec 11, 2019
CONTRIBUTORS Initialize a readme file Nov 24, 2019
LICENSE Licence it to be BSD-3 Nov 24, 2019
MANIFEST.in ⬆️ Include templates, statics in the packages and bump the version Nov 25, 2019
Procfile [#1] Show state descriptions in a tooltip when hovering the states in… Nov 28, 2019
README.rst Change discord url to be for river-admin channel Dec 3, 2019
babel.config.js Restructure the folder Nov 24, 2019
jest.config.js Restructure the folder Nov 24, 2019
jsconfig.json Restructure the folder Nov 24, 2019
manage.py Finalize demo and tidy up the folders Nov 27, 2019
package.json ⬆️ Bump version Dec 11, 2019
publish.sh Delete previous build before publish Nov 25, 2019
requirements.txt Fix asset paths after build Nov 26, 2019
setup.py ⬆️ Bump version Dec 11, 2019
test_settings.py Finalize demo and tidy up the folders Nov 27, 2019
test_urls.py Finalize demo and tidy up the folders Nov 27, 2019
tox.ini Use whitenoise dependency version that supports python 3.4 for python… Feb 6, 2020
vue.config.js Fix asset paths after build Nov 26, 2019
yarn.lock [#5] Fix vulnerability issue with serializer-javascript Dec 11, 2019

README.rst

River Admin

Build Status Documentation Status GitHub license Coverage Status Code Quality PyPI - Downloads Discord

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

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

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

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

Shipping Workflow Img

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

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.

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.

You can’t perform that action at this time.