flowchart.fun

https://flowchart.fun | Generate diagrams from text

Summary

flowchart.fun is a lightweight application to generate flowcharts and diagrams from text. It is built with create-react-app and cytoscape.js This app also allows users to log in and save hosted charts, as well as send feedback. These features are built with Vercel functions / supabase, and sendgrid respectively.

Note: It's not necessary to configure these services to run a lightweight version of this app. Read below to find out more.

Installation

1. Clone this repository
2. cd flowchart-fun
3. yarn

How to run without login features

yarn start

How to run with login features

To run with full functionality you'll need accounts with vercel, sendgrid, supabase and stripe. Then you'll need to copy and fill the environment variables in app/.env.example to app/.env. Then

vercel dev

Workspaces

This repository is organized in workspaces. /app contains the code for the react application and /module contains the code for the deprecated flowchart-fun npm module.

Releasing

Documenting so as not to forget!

• Work on feature branches which are merged to dev
• When ready to release update version in /app/package.json and commit directly to dev. Push.
• Open pull request from dev to main
• Merging pull request should create new github release

Contributing

We always welcome contributions! Before opening a pull request with a new feature, consider opening an issue or discussion to gauge support and/or confirm your implementation.