https://github.com/viewflow/cookbook
Sample projects for viewflow and django-material
https://github.com/viewflow/cookbook
Last synced: 10 months ago
JSON representation
Sample projects for viewflow and django-material
- Host: GitHub
- URL: https://github.com/viewflow/cookbook
- Owner: viewflow
- Created: 2015-05-08T10:32:49.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T11:31:45.000Z (about 1 year ago)
- Last Synced: 2025-03-30T16:07:21.198Z (11 months ago)
- Language: Python
- Size: 90.4 MB
- Stars: 295
- Watchers: 20
- Forks: 139
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](./crud101) - Admin-style CRUD application
- [Dashboard](./dashboard) - Quick material-design dashboard with Chart.js
- [Forms 101](./forms101) - Various form options samples
- [FSM 101](./fsm101) - Finite state machine workflow UI and REST API
- [JSON 101](./json101) - JSON storage and polymorphic user model
- [Legacy DB](./legacy_db) - Django and Database with composite foreign keys sample
- [Timescale DB](./timescale_db) - Access to timescale database from Django
- [Workflow 101](./workflow101) - 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:
```bash
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](https://github.com/viewflow/cookbook/tree/v1).
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](https://stackoverflow.com/questions/tagged/viewflow) or [GitHub
Discussions](https://github.com/viewflow/viewflow/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