Viewflow Cookbook

Welcome to the Viewflow Cookbook! This repository contains a collection of sample projects and recipes for the latest version of the Viewflow library.

What's in this repository?

This repository contains a variety of samples and recipes that demonstrate the different features and capabilities of Viewflow. You'll find examples of simple workflows, complex workflows, custom UI components, and more.

To get started, simply browse the different samples and choose the one that best fits your needs. Each sample includes detailed instructions on how to set it up and run it.

• CRUD 101 - Admin-style CRUD application
• Dashboard - Quick material-design dashboard with Chart.js
• Forms 101 - Various form options samples
• FSM 101 - Finite state machine workflow UI and REST API
• JSON 101 - JSON storage and polymorphic user model
• Legacy DB - Django and Database with composite foreign keys sample
• Timescale DB - Access to timescale database from Django
• Workflow 101 - HelloWorld workflow sample

How to use this repository

To use the samples in this repository, you'll need to have Django and Viewflow installed. Once you've installed these dependencies, you can clone this repository and run the sample projects locally.

To clone this repository, run the following command:

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

Then, navigate to the sample project you want to run, and follow the instructions in the README file.

Samples for previous versions

If you're using an older version of Viewflow, you can still find samples for those versions in the v1 branch. However, we strongly recommend upgrading to the latest version of Viewflow for the best performance, features, and security.

Getting Help

If you have any questions about Viewflow or the Viewflow Cookbook, feel free to reach out to the Viewflow community on Stack Overflow or GitHub Discussions We're always happy to help!

Contributions

Please feel free to use these samples as a starting point for your own projects. If you have any suggestions for new samples, please open an issue