Skip to content

nishindudu/Drawiii

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Drawiii Logo

🎨 Drawiii

A collaborative drawing canvas for you and your friends

💖 Features

  • Real Time Collaboration: Draw together with anyone in real-time.
  • No Sign-Up Required: Starting a drawing session only requires choosing a room name.
  • Shareable Links: Invite anyone to your drawing session with a simple link.

🎯 Usage

  1. Clone the repo:

    git clone https://github.com/nishindudu/Drawiii.git
  2. Navigate to the project directory:

    cd Drawiii
  3. Remove or Replace Cloudflare Analytics Script:

    Open the frontend/src/app/layout.js file and remove the following line:

    <script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{"token": "<CLOUDFLARE_TOKEN>"}'></script>
  4. Navigate to Frontend Code and Install dependencies:

    cd frontend
    npm install
  5. Run build command from the frontend directory:

    npm run build
  6. Navigate to Backend Code and Install dependencies:

    cd backend
    pip install -r requirements.txt
  7. Run the Backend Server:

    gunicorn -k eventlet -w 1 app:app

    or if you prefer Flask's built-in server for development:

    python app.py
  8. Open the Frontend: Open your browser and go to http://localhost:<port> (port will be shown in the terminal) to start drawing!

For a live demo, visit Drawiii Demo.

📸 Screenshots

Room Creation Page: Room Creation Page

Drawing Canvas: Drawing Canvas

📁 Project Structure

Drawiii/
├── backend/
│   ├── app.py
│   ├── requirements.txt
├── frontend/
│   ├── drawiii/            # Main frontend directory
│   │   ├── src/app         # Main frontend code
├── screenshots             # Contains screenshots for documentation

⚙️ Technologies Used

  • Frontend: React, Next.js, socket.io
  • Backend: Flask, socket.io

🤝 Contributing

Contributions are welcome to Drawiii! If you'd like to help out, please follow these steps:

  1. Fork the repository: Click the "Fork" button at the top right of this page.
  2. Clone your fork:
    git clone https://github.com/<your-username>/Drawiii.git
  3. Create a new branch:
    git checkout -b my-feature-branch
  4. Make your changes: Edit the code as you see fit.
  5. Commit your changes:
    git commit -m "Add my feature"
  6. Push to your fork:
    git push origin my-feature-branch
  7. Create a pull request: Go to the original repository and click "New Pull Request".

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

Thank you for your contributions! ✨

Releases

No releases published

Packages

 
 
 

Contributors