Skip to content

kohunglee/flowchart-fun

 
 

Repository files navigation

Flowchart Fun

Flowchart Fun is a webapp for quickly generating flowcharts from text. With a fast and intuitive workflow, you can visualize your ideas and plans in minutes.

screenshot

📝 Example

For an example of how Flowchart Fun works, take the following input:

Node A
  goes to: Node B
  and: Node C
    goes back to: (Node A)

You can generate this flowchart with just a few clicks:

example flowchart

🛠️ Development

Flowchart Fun is built with React and cytoscape.js.

💡 Prerequisites

If you plan on developing the premium features, you will need accounts on Vercel, Supabase, Stripe and Sendgrid.

🚀 Getting Started

  1. Clone the repository
  2. Copy .env.example to .env and add env variables
  3. pnpm install and vercel dev

🔒 To run with login features:

vercel dev

⚙️ To run without login features:

pnpm dev

🌐 Translations

We welcome anyone interested in helping us add translations to Flowchart Fun. Translations can be added to the .po files located in /app/src/locales/[language]/messages.po. After adding translations, please run pnpm -F app compile. We would appreciate your help in making Flowchart Fun accessible in even more languages!

💬 Interested in Adding a Language?

Let us know about your plans in the Discord, and we'd be glad to lend a helping hand.

🧪 Tests

To ensure quality and accuracy, Flowchart Fun employs Jest for unit testing and Playwright for e2e testing.

Unit Tests

pnpm -F app test

E2E Tests

pnpm -F app e2e

🔍 Analyzing the Bundle

pnpm -F app build && pnpm -F app analyze

🤝 Contributing

We welcome contributions! Please fork the dev branch in order to develop and test your feature.

If you have any questions, feel free to join the discussion on Discord.

About

超级简易流程图制作

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 68.5%
  • JavaScript 20.2%
  • CSS 10.8%
  • Other 0.5%