Reusable workflow library for Django
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.rst

django-viewflow

Viewflow is a lightweight reusable workflow library that helps to organize people collaboration business logic in django applications.

In conjunction with django-material, they could be used as the framework to build ready to use business applications in minutes.

http://viewflow.io.

https://requires.io/github/viewflow/viewflow/requirements.svg?branch=master https://coveralls.io/repos/viewflow/viewflow/badge.png?branch=master
  • Viewflow 1.1.x compatible with Django 1.8/1.9/1.10/1.11 (supported till Django 1.8 lifetime/April 2018)
  • Viewflow 1.2.x compatible with Django 1.11/2.0 (supported till Django 1.11 lifetime/April 2020)

Introduction

https://raw.githubusercontent.com/viewflow/viewflow/master/demo/shipment/doc/ShipmentProcess.png

Django web framework solves only technical problems related to the client-server interaction on top of the stateless HTTP protocol. Model-View-Template separation pattern helps to maintain simple CRUD based logic. Viewflow is the library that offers an additional layer of django web framework, allows explicitly specify people's workflow and extracts collaboration logic from django views.

Viewflow layer is based on the BPMN - business process management and notation standard. It is the graphical notation readily understandable by all business stakeholders and software developers. Viewflow bridges the gap between a picture as the software specification and the working solution.

Django-Material frontend is the lightweight alternative to the django admin and allows you to build business applications. It's based on Google Material Design, that could be easily customized to your brand colors. Django-Material takes care of site-wide navigation, complex form construction, datagrids and CRUD functionality. Ready for fast development of any CRM, ERP, Business Management Software.

Quick start

5 minutes introduction tutorial

Demo

Viewflow comes with reference UI implementation on top of django-material project.

http://demo.viewflow.io

To checkout and run open source demo version locally, you need to have git and tox tools installed.

git clone https://github.com/viewflow/viewflow.git
cd viewflow

TOXENV=py36-dj111 tox -- python manage.py migrate --settings=demo.settings
TOXENV=py36-dj111 tox -- python manage.py loaddata demo/helloworld/fixtures/helloworld/default_data.json --settings=demo.settings
TOXENV=py36-dj111 tox -- python manage.py runserver --settings=demo.settings

Then, you can open http://127.0.0.1:8000 and login with admin:admin username/password pair.

Documentation

Read the documentation at the http://docs.viewflow.io/

Cookbook

Advanced customization samples

https://github.com/viewflow/cookbook

Contribution

Please open an issue to discuss. before pushing any new functionality.

See also - Contribution Agreement

License

Viewflow is an Open Source project licensed under the terms of the AGPL license - The GNU Affero General Public License v3.0 with the Additional Permissions described in LICENSE_EXCEPTION

Viewflow Pro has a commercial-friendly license allowing private forks and modifications of Viewflow. You can find the commercial license terms in COMM-LICENSE. Please see FAQ for more detail.

Latest changelog

1.3.0 2018-08-23

  • Django 2.1 support
  • Support task permission checks on user model subclasses
  • [PRO] django-rest-swagger 2.2.0 support