https://github.com/syedzawwarahmed/inksync
A white boarding application with Real-time collaboration.
https://github.com/syedzawwarahmed/inksync
express react react-konva socket-io
Last synced: 2 months ago
JSON representation
A white boarding application with Real-time collaboration.
- Host: GitHub
- URL: https://github.com/syedzawwarahmed/inksync
- Owner: SyedZawwarAhmed
- Created: 2024-10-19T10:01:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-22T20:03:02.000Z (over 1 year ago)
- Last Synced: 2024-10-23T05:56:23.925Z (over 1 year ago)
- Topics: express, react, react-konva, socket-io
- Language: TypeScript
- Homepage:
- Size: 137 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# InkSync
A feature-rich whiteboarding application designed for creativity and collaboration. Draw, design, and interact with ease!
## 🚀 Features
- ✏️ **Drawing Tools**: Pencil, Eraser, Rectangle, and Ellipse tools
- 🎨 **Customizable Styles**: Adjustable stroke width and color selection
- 🖱️ **Canvas Interaction**: Zoom and drag for smooth navigation
- 📝 **Upcoming Features**: Text tool, shape transformation, undo/redo, real-time collaboration, and recording/playback
## 🛠️ Tech Stack
- **React** – Frontend UI library
- **Vite** – Fast build tool and development server
- **Konva** & **react-konva** – Canvas drawing and shape manipulation
- **Tailwind CSS** – Utility-first CSS framework for responsive design
- **Zustand** – Lightweight state management
- **Socket.IO** _(Coming Soon)_ – Real-time collaboration
## 🔗 Live Demo & GitHub
- 🌐 **Live Demo:** [https://inksync.zawwarahmed.com]
- 💻 **GitHub Repository:** [https://github.com/SyedZawwarAhmed/InkSync]
## 📦 Installation
1. **Clone the repository:**
```bash
git clone https://github.com/SyedZawwarAhmed/InkSync
cd InkSync
```
2. **Install all dependencies for both frontend and backend:**
```bash
pnpm run install
```
3. **Run the development server:**
This will start both the frontend and backend servers simultaneously:
```bash
pnpm run dev
```
4. **Build for production:**
```bash
pnpm run build
```
## 🤝 Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve the app.
## 📄 License
This project is licensed under the [MIT License](LICENSE).