WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit b4434b6

Browse files
committed
feat: readme
1 parent cdcf04e commit b4434b6

File tree

2 files changed

+74
-10
lines changed

2 files changed

+74
-10
lines changed

README.md

Lines changed: 74 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,80 @@
1-
# cookethflow
1+
<p align="center">
2+
<div align="center">
23

3-
A new Flutter project.
4+
[![Welcome to my profile](https://img.shields.io/badge/Hello,Programmer!-Welcome-blue.svg?style=flat&logo=github)](https://github.com/CookethOrg)
5+
[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/CookethOrg/Cooketh-Flow)
6+
![Stars](https://img.shields.io/github/stars/CookethOrg/Cooketh-Flow?style=flat&logo=github)
7+
![Forks](https://img.shields.io/github/forks/CookethOrg/Cooketh-Flow?style=flat&logo=github)
48

5-
## Getting Started
9+
</div>
10+
<div align="center">
11+
<a href="https://github.com/CookethOrg/Cooketh-Flow">
12+
<img src="assets/images/Frame 375.png" alt="Cooketh Flow logo" height="300" />
13+
</a>
14+
</div>
15+
<h2 align="center">Cooketh Flow</h2>
16+
<p align="center"> Transform chaos into clarity. </p>
17+
<br />
18+
<!-- <br /> -->
619

7-
This project is a starting point for a Flutter application.
20+
[Cooketh Flow](https://cookethflow.framer.website/) is an open-source, powerful visual thinking and unified productivity tool designed for teams and individuals to brainstorm, sketch, and organize ideas effortlessly. Whether you're mapping out ideas, designing user flows, organizing tasks or simply just taking notes, Cooketh Flow provides an intuitive interface for organizing and executing tasks effortlessly. <!-- <div align="center">
21+
<a href="https://github.com/CookethOrg/Cooketh-Flow">
22+
<img src="assets/ss.png" alt="Cooketh Flow logo" height="300" />
23+
</a>
24+
</div> -->
825

9-
A few resources to get you started ifthis is your first Flutter project:
26+
---
1027

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
28+
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/CookethOrg/Cooketh-Flow?logo=github)](https://CookethOrg/Cooketh-Flow) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/CookethOrg/Cooketh-Flow?color=bluevoilet&logo=github)](https://github.com/CookethOrg/Cooketh-Flow/commits/) [![GitHub repo size](https://img.shields.io/github/repo-size/CookethOrg/Cooketh-Flow?logo=github)](https://github.com/CookethOrg/Cooketh-Flow)
1329

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
30+
31+
## ✨ Features
32+
33+
- 🔗 **Collaborate** – Work together, wherever you are. Invite teammates to brainstorm, map flows, or build diagrams with you. Co-create without missing a beat.
34+
- 📂 **All-in-One Workspace** – Create flowcharts, map ideas, leave comments, and organize everything — all in one streamlined canvas.
35+
-**Works Everywhere** – Access your boards on desktop, tablet, or mobile, Cooketh Flow runs smoothly across all your devices.
36+
37+
---
38+
39+
## 🛠️ Tech Stack
40+
41+
| Technology | Purpose |
42+
|------------|---------|
43+
| **Flutter** | Cross-platform UI development |
44+
| **Supabase** | Backend & real-time sync |
45+
46+
---
47+
48+
## 🚀 Setup & Installation
49+
50+
### Prerequisites
51+
- Flutter SDK installed
52+
- Supabase project setup
53+
- A code editor (VS Code / Android Studio recommended)
54+
55+
### Installation Steps
56+
Cooketh Flow is currently available in alpha version for web only.
57+
Check out the [live site](https://cookethflow.cookethcompany.xyz/)
58+
59+
### Setup for build
60+
```bash
61+
# Clone the repository
62+
git clone https://github.com/your-username/Cooketh-Flow.git
63+
cd cooketh-flow
64+
65+
# Install dependencies
66+
flutter pub get
67+
68+
# Run the app
69+
flutter run
70+
```
71+
---
72+
## 📜 License
73+
74+
This project is licensed under the **MIT License** – see the [`LICENSE`](LICENSE) file for details.
75+
<br>
76+
I, [Subroto Banerjee](https://github.com/TeeWrath), am the Benevolent Dictator For Life (BDFL) of [Cooketh Flow](https://github.com/CookethOrg/Cooketh-Flow), leading its vision and development. I welcome contributions under our MIT license to make this tool awesome!
77+
78+
---
79+
80+
Made with ❤️

assets/images/Frame 375.png

7.52 KB
Loading

0 commit comments

Comments
 (0)