Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md To Include Features #653

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated README.md To Include Features #653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@

<img src="https://github.com/tone-row/flowchart-fun/blob/main/app.png?raw=true" alt="screenshot" width="600" />

## Features

Flowchart Fun is actively working on implementing new and innovative features! Some of are features include:
-Editing with AI
-Importing Data
-Variety of Templates
-Importing Data
-Different Themes
-10 Layout Designs
-Different Background Colors
-Different Node Shapes and Colors
-Log In to Save Your Charts! Creating An Account is Quick and Easy!
-Try Out FlowChart Fun Pro For a Variety of Premium Features!

## 📝 Example

For an example of how Flowchart Fun works, take the following input:
Expand All @@ -21,8 +35,17 @@ You can generate this flowchart with just a few clicks:

## 🛠️ Development

Before making a contribution to Flowchart Fun, you should know a little bit about the technologies we're using.
After that, you should be ready to help out!

Flowchart Fun is built with [React](https://reactjs.org/) and [cytoscape.js](https://github.com/cytoscape/cytoscape.js).

-**React:** A JavaScript library for building dynamic user interfaces based on components.
-Want to familiarize yourself with React? Read the official React documentation (https://reactjs.org/docs/getting-started.html)
to learn more.
-**Cytoscape:** CytoScape is a Graph theory (network) library for visualisation and analysis.
-Learn more about Cytoscape on its offical website (https://js.cytoscape.org/#introduction/factsheet).

### 💡 Prerequisites

If you plan on developing the premium features, you will need accounts on [Vercel](https://vercel.com/docs/concepts/functions/introduction), [Supabase](https://supabase.io/), [Stripe](https://stripe.com/) and [Sendgrid](https://sendgrid.com/).
Expand All @@ -45,6 +68,16 @@ Note: You will need to create a [Vercel account](https://vercel.com/signup) and

### 🌐 Translations

Flowchart Fun is available in a variety of languages:
-Deutsch
-English
-Español
-Fançais
-हिन्दी
-한국어
-Português
-中文

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?
Expand Down