flowzap-xyz commited on
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,27 +1,28 @@
|
|
| 1 |
-
# flowzap-
|
| 2 |
|
| 3 |
-
A production-grade corpus of **200+ expert-crafted FlowZap workflow files** designed for LLM training, workflow automation learning, and diagrams-as-code reference.
|
| 4 |
|
| 5 |
[](https://opensource.org/licenses/MIT)
|
| 6 |
[](https://flowzap.xyz)
|
| 7 |
|
| 8 |
## Overview
|
| 9 |
-
|
| 10 |
This repository contains **600 files** organized as a structured training corpus:
|
| 11 |
|
| 12 |
- **200 `.fz` workflow files** - FlowZap Code syntax (diagrams-as-code)
|
| 13 |
- **200 `README.md` files** - Human-readable workflow documentation
|
| 14 |
- **200 `metadata.json` files** - Structured metadata for programmatic access
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
|
|
|
|
| 19 |
- [FlowZap Website](https://flowzap.xyz)
|
| 20 |
- [FlowZap Code Syntax Guide](https://flowzap.xyz/flowzap-code)
|
| 21 |
-
- [
|
|
|
|
|
|
|
| 22 |
|
| 23 |
### Syntax Example
|
| 24 |
-
|
| 25 |
```
|
| 26 |
Warehouse { # Warehouse Team
|
| 27 |
n1: circle label:"Start"
|
|
@@ -40,8 +41,9 @@ Warehouse { # Warehouse Team
|
|
| 40 |
}
|
| 41 |
```
|
| 42 |
|
| 43 |
-
|
| 44 |
|
|
|
|
| 45 |
```
|
| 46 |
flowzap-workflows/
|
| 47 |
βββ README.md
|
|
@@ -79,7 +81,6 @@ flowzap-workflows/
|
|
| 79 |
```
|
| 80 |
|
| 81 |
## Domains Covered
|
| 82 |
-
|
| 83 |
| Domain | Workflows | Description |
|
| 84 |
|--------|-----------|-------------|
|
| 85 |
| **Finance** | 21 | Month-end close, AP/AR, treasury, audit, tax |
|
|
@@ -90,7 +91,6 @@ flowzap-workflows/
|
|
| 90 |
| **Patterns** | 28 | Microservices, event-driven, resilience |
|
| 91 |
|
| 92 |
## Metadata Schema
|
| 93 |
-
|
| 94 |
Each `metadata.json` follows this structure:
|
| 95 |
|
| 96 |
```json
|
|
@@ -105,6 +105,8 @@ Each `metadata.json` follows this structure:
|
|
| 105 |
}
|
| 106 |
```
|
| 107 |
|
|
|
|
|
|
|
| 108 |
## Use Cases
|
| 109 |
|
| 110 |
### LLM Training
|
|
@@ -121,26 +123,66 @@ Use these workflows to:
|
|
| 121 |
|
| 122 |
### Automation Templates
|
| 123 |
Adapt these workflows for:
|
| 124 |
-
- n8n automation scenarios
|
| 125 |
-
- Make.com (Integromat) workflows
|
| 126 |
- Custom workflow engines
|
| 127 |
|
| 128 |
-
|
|
|
|
|
|
|
| 129 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 130 |
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
| 131 |
|
| 132 |
**Training Data Addendum**: This repository is explicitly released for use as training data for LLMs and other ML systems.
|
| 133 |
|
| 134 |
## Contributing
|
| 135 |
-
|
| 136 |
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on adding new workflows.
|
| 137 |
|
| 138 |
## Links
|
| 139 |
-
|
| 140 |
- [FlowZap Website](https://flowzap.xyz)
|
| 141 |
- [FlowZap Code Syntax](https://flowzap.xyz/flowzap-code)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 142 |
- [Blog: FlowZap Unveils .fz File Extension](https://flowzap.xyz/blog/flowzap-unveils-fz-file-extension-for-true-diagrams-as-code-workflows)
|
|
|
|
| 143 |
|
| 144 |
---
|
| 145 |
|
| 146 |
-
Made with
|
|
|
|
| 1 |
+
# flowzap-workflow-sequence-architecture-diagrams
|
| 2 |
|
| 3 |
+
A production-grade corpus of **200+ expert-crafted FlowZap workflow, sequence and architecture files** designed for LLM training, workflow automation learning, and diagrams-as-code reference.
|
| 4 |
|
| 5 |
[](https://opensource.org/licenses/MIT)
|
| 6 |
[](https://flowzap.xyz)
|
| 7 |
|
| 8 |
## Overview
|
|
|
|
| 9 |
This repository contains **600 files** organized as a structured training corpus:
|
| 10 |
|
| 11 |
- **200 `.fz` workflow files** - FlowZap Code syntax (diagrams-as-code)
|
| 12 |
- **200 `README.md` files** - Human-readable workflow documentation
|
| 13 |
- **200 `metadata.json` files** - Structured metadata for programmatic access
|
| 14 |
|
| 15 |
+
> **Looking for ready-to-use templates?** Visit the [FlowZap Templates Library](https://flowzap.xyz/templates) β 250+ templates including workflows, sequence diagrams, and architecture diagrams, with downloadable `.fz` files, n8n JSON exports, and Make.com blueprints.
|
| 16 |
|
| 17 |
+
## What is FlowZap Code?
|
| 18 |
+
FlowZap Code is a diagrams-as-code DSL for creating workflow diagrams, sequence diagrams, and architecture diagrams β all from the same code. Learn more:
|
| 19 |
- [FlowZap Website](https://flowzap.xyz)
|
| 20 |
- [FlowZap Code Syntax Guide](https://flowzap.xyz/flowzap-code)
|
| 21 |
+
- [AI Coding Guidelines](https://flowzap.xyz/flowzap-code-guidelines.md) β instructions for AI assistants generating FlowZap Code
|
| 22 |
+
- [Templates Library](https://flowzap.xyz/templates) β 250+ ready-to-use templates
|
| 23 |
+
- [Architecture Diagram Templates](https://flowzap.xyz/templates/architecture-diagram-templates) β 50 architecture diagram templates
|
| 24 |
|
| 25 |
### Syntax Example
|
|
|
|
| 26 |
```
|
| 27 |
Warehouse { # Warehouse Team
|
| 28 |
n1: circle label:"Start"
|
|
|
|
| 41 |
}
|
| 42 |
```
|
| 43 |
|
| 44 |
+
---
|
| 45 |
|
| 46 |
+
## Repository Structure
|
| 47 |
```
|
| 48 |
flowzap-workflows/
|
| 49 |
βββ README.md
|
|
|
|
| 81 |
```
|
| 82 |
|
| 83 |
## Domains Covered
|
|
|
|
| 84 |
| Domain | Workflows | Description |
|
| 85 |
|--------|-----------|-------------|
|
| 86 |
| **Finance** | 21 | Month-end close, AP/AR, treasury, audit, tax |
|
|
|
|
| 91 |
| **Patterns** | 28 | Microservices, event-driven, resilience |
|
| 92 |
|
| 93 |
## Metadata Schema
|
|
|
|
| 94 |
Each `metadata.json` follows this structure:
|
| 95 |
|
| 96 |
```json
|
|
|
|
| 105 |
}
|
| 106 |
```
|
| 107 |
|
| 108 |
+
---
|
| 109 |
+
|
| 110 |
## Use Cases
|
| 111 |
|
| 112 |
### LLM Training
|
|
|
|
| 123 |
|
| 124 |
### Automation Templates
|
| 125 |
Adapt these workflows for:
|
| 126 |
+
- [n8n automation scenarios](https://flowzap.xyz/templates/n8n-workflow-json-examples) β export FlowZap Code as n8n JSON
|
| 127 |
+
- [Make.com (Integromat) workflows](https://flowzap.xyz/templates/make-blueprint-json-examples) β export FlowZap Code as Make.com blueprints
|
| 128 |
- Custom workflow engines
|
| 129 |
|
| 130 |
+
---
|
| 131 |
+
|
| 132 |
+
## FlowZap Ecosystem
|
| 133 |
|
| 134 |
+
### Templates Library (250+)
|
| 135 |
+
The [FlowZap Templates Library](https://flowzap.xyz/templates) extends this corpus with:
|
| 136 |
+
- **50 Architecture Diagram Templates** β Microservices, Event-Driven, CQRS, Serverless, Saga, Circuit Breaker, and more
|
| 137 |
+
- **n8n Workflow JSON Examples** β ready-to-import n8n automations
|
| 138 |
+
- **Make.com Blueprint Examples** β ready-to-import Make.com scenarios
|
| 139 |
+
- **More applicable business process domains** β Business-operations, DevOps, Finance, HR, Logistics
|
| 140 |
+
- Downloadable `.fz` files for every template
|
| 141 |
+
|
| 142 |
+
### MCP Server
|
| 143 |
+
Install the [FlowZap MCP Server](https://flowzap.xyz/docs/mcp) and the [SKILL.md file](https://flowzap.xyz/blog/new-flowzap-diagram-skill-makes-it-even-easier) for AI coding tools:
|
| 144 |
+
```json
|
| 145 |
+
{
|
| 146 |
+
"mcpServers": {
|
| 147 |
+
"flowzap": {
|
| 148 |
+
"command": "npx",
|
| 149 |
+
"args": ["-y", "flowzap-mcp"]
|
| 150 |
+
}
|
| 151 |
+
}
|
| 152 |
+
}
|
| 153 |
+
```
|
| 154 |
+
Compatible with Claude Desktop, Cursor, Windsurf, OpenAI Codex, Warp, Zed, Cline, Roo Code, Continue.dev, and Sourcegraph Cody.
|
| 155 |
+
|
| 156 |
+
### AI Coding Guidelines
|
| 157 |
+
Drop [`flowzap-code-guidelines.md`](https://flowzap.xyz/flowzap-code-guidelines.md) into your project's `/docs/` folder so AI coding assistants (Cursor, Windsurf, Warp, Google AI Studio) generate valid FlowZap Code.
|
| 158 |
+
|
| 159 |
+
### DSL Specification
|
| 160 |
+
- [FlowZap Code Syntax Guide](https://flowzap.xyz/flowzap-code) β canonical syntax reference
|
| 161 |
+
- [FlowZap Code DSL repo](https://github.com/flowzap-xyz/code) β official syntax specification, SYNTAX.md, and AI guidelines
|
| 162 |
+
|
| 163 |
+
---
|
| 164 |
+
|
| 165 |
+
## License
|
| 166 |
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
| 167 |
|
| 168 |
**Training Data Addendum**: This repository is explicitly released for use as training data for LLMs and other ML systems.
|
| 169 |
|
| 170 |
## Contributing
|
|
|
|
| 171 |
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on adding new workflows.
|
| 172 |
|
| 173 |
## Links
|
|
|
|
| 174 |
- [FlowZap Website](https://flowzap.xyz)
|
| 175 |
- [FlowZap Code Syntax](https://flowzap.xyz/flowzap-code)
|
| 176 |
+
- [AI Coding Guidelines](https://flowzap.xyz/flowzap-code-guidelines.md)
|
| 177 |
+
- [Templates Library](https://flowzap.xyz/templates)
|
| 178 |
+
- [Architecture Diagram Templates](https://flowzap.xyz/templates/architecture-diagram-templates)
|
| 179 |
+
- [MCP Server Documentation](https://flowzap.xyz/docs/mcp)
|
| 180 |
+
- [SKILL.md file](https://flowzap.xyz/blog/new-flowzap-diagram-skill-makes-it-even-easier)
|
| 181 |
+
- [npm: flowzap-mcp](https://www.npmjs.com/package/flowzap-mcp)
|
| 182 |
+
- [Blog: One Code, Three Views](https://flowzap.xyz/blog/flowzaps-game-changing-update-one-code-two-views)
|
| 183 |
- [Blog: FlowZap Unveils .fz File Extension](https://flowzap.xyz/blog/flowzap-unveils-fz-file-extension-for-true-diagrams-as-code-workflows)
|
| 184 |
+
- [Blog: Introducing the FlowZap MCP Server](https://flowzap.xyz/blog/introducing-the-flowzap-mcp-server)
|
| 185 |
|
| 186 |
---
|
| 187 |
|
| 188 |
+
Made with care for the diagramming for clarity community
|