📓 COLLABORATIVE-NOTEPAD

Empower Collaboration, Transform Ideas into Reality

Built with the tools and technologies:

---

🚀 About the Project

Collaborative-Notepad is a collaborative text editor built using Flask and Socket.IO that allows multiple users to edit the same document in real time. It's simple, fast, and perfect for instant collaboration.

---

✨ Features

• 🔁 Real-time Collaboration – See live changes from everyone in the room.
• 🔒 Room-based Editing – Unique room ID for each session.
• 🌗 Dark/Light Theme – Toggle between light and dark modes.
• 🔗 Sharable Links – Copy the room URL and invite collaborators instantly.

---

🛠️ Tech Stack

Backend
Flask, Flask-SocketIO, eventlet, GitLab CI/CD

Frontend
HTML, CSS, JavaScript, Socket.IO Client

Realtime Communication
WebSockets

---

📦 Installation

1. Clone the Repository

git clone https://github.com/your-username/collaborative-flask-editor.git
cd collaborative-flask-editor

2. Create a Virtual Environment

python -m venv venv

On Windows:

venv\Scripts\activate

On Linux/macOS:

source venv/bin/activate

Install the Dependencies

pip install flask flask-socketio eventlet

Run the Application

python app.py

Open in Browser

http://localhost/

📁 Project Structure

collaborative-flask-editor/
│
├── Dockerfile              # Container setup
├── docker-compose.yml      # Compose config for multi-service deployment
├── .gitlab-ci.yml          # GitLab CI/CD pipeline definition
├── requirements.txt        # Python dependencies
├── app.py                  # Main Flask application
│
├── templates/
│   ├── landing.html        # Landing page UI
│   └── editor.html         # Collaborative editor interface
│
├── static/
│   └── favicon.png         # App icon
│
└── .gitignore              # Ignored files (env, pycache, etc.)

🐳 Docker Usage

▶️ Run the Container

docker-compose up -d

Then open your browser and visit:

http://localhost/

🛑 Stop the Container

docker-compose down

🤝 Contributors

Thanks to the amazing people who helped build this project:

• 👩‍💻 @Smaranika2005 – Co-developer

• 🧑‍💻 @shinjansarkar – Maintainer

Want to contribute? Fork the repo and open a pull request 🚀