Skip to content

Janhvibabani/code-wall

Repository files navigation

CodeWall 🎨

A real-time collaborative doodling platform where creativity knows no bounds. CodeWall allows users to create virtual rooms and invite others for synchronized drawing sessions.

✨ Features

  • Real-time Collaboration: Draw together with friends and colleagues in synchronized virtual rooms
  • Room Management: Create private rooms and invite others with unique room codes
  • Rich Drawing Tools: Powered by Fabric.js for a smooth drawing experience
  • Responsive Design: Works seamlessly across different devices and screen sizes
  • Modern UI: Clean and intuitive interface built with Tailwind CSS

🛠️ Tech Stack

  • Frontend: React.js with Next.js for server-side rendering
  • Styling: Tailwind CSS for modern, responsive design
  • Canvas: Fabric.js for powerful drawing capabilities
  • Language: TypeScript for type-safe code
  • Real-time Communication: WebSocket for live collaboration

🚀 Getting Started

Prerequisites

  • Node.js (v14.0 or higher)
  • npm or yarn
  • Git

Installation

  1. Clone the repository:
git clone https://github.com/Janhvibabani/code-wall.git
cd code-wall
  1. Install dependencies:
npm install
# or
yarn install
  1. Start the development server:
npm run dev
# or
yarn dev
  1. Open http://localhost:3000 in your browser

🎯 Usage

  1. Create a new room or join an existing one using a room code
  2. Start drawing using the available tools
  3. Share your room code with others to collaborate
  4. Draw together in real-time!

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

👏 Acknowledgments

  • Fabric.js for the powerful canvas manipulation library
  • Next.js for the amazing React framework
  • Tailwind CSS for the utility-first CSS framework