FlowFairy

FlowChart creator designed for professionals, educators, and researchers.

Simplify, Connect, Create Where Everything Flows.

Website · LinkedIn · Email · Report Bug · Request Feature

_{Coded by Yulu Duan 👋}

🚀 Features

• 🔗 Link nodes to essential documents and notes for instant access

• 🖊️ Enable rich text editing alongside your documents

🛠️ Installation Steps

1. Clone the repository

git clone https://github.com/YuluDuan/flowfairy.git

2. Change the working directory

cd flowfairy

3. Install dependencies

npm install

4. Run the app

npm run dev

🌟 You are all set!

Open http://localhost:3000 with your browser to see the result.

🍰 Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

💻 Built with

• Typescript
• Next.js 13
• React
• MongoDB
• Zustand
• Tailwind CSS

💡 What I Learned:

• Utilizing Next.js13 parallel and intercept routing, along with nested layouts
• Incorporating State management with Zustand
• Using Tailwind CSS for efficient and maintainable styling
• Writing RESTful API using Next.js and TypeScript
• Integrating Third-party API

📈 Future Development:

• Adding a Word plugin for easy citation in Microsoft Word.
• Expanding functionality with different types of nodes.
• Add Tests

License

FlowFairy is open-sourced software licensed under the MIT license.

Author

• Yulu Duan (@YuluDuan)

📹 Video Demo

VideoDemoFlowFairy.mp4