Git Product home page Git Product logo

draw-it-out's Introduction

Draw-it-out: Online Whiteboard App

Introduction

Draw-it-out is an online whiteboard tool built using ReactJS and TailwindCSS. It allows users to draw, sketch, and take snapshots of their creations. The intuitive interface and responsive design make it easy to use across various devices.

Stars ๐Ÿด Forks Issues Open PRs Closed PRs
Stars Forks Issues Open Pull Requests Closed Pull Requests

Getting Started

Comprehensive Guide for Installing and Setting Up Draw-it-out

Prerequisites

Installation Instructions

For Windows

  1. Install Node.js

    • Download the Node.js installer from the Node.js download page.
    • Run the installer and follow the setup instructions.
    • Confirm the installation by opening Command Prompt and typing:
      node -v
      npm -v
  2. Clone the Repository

    • Open Command Prompt.
    • Navigate to the directory where you want to clone the repository:
      cd path\to\your\directory
    • Clone the repository:
      git clone https://github.com/singodiyashubham87/Draw-it-out.git
    • Navigate into the project directory:
      cd Draw-it-out
  3. Install Dependencies

    • Install the required dependencies by running:
      npm install
  4. Start the Application

    • Start the application in development mode:
      npm run dev

For macOS

  1. Install Node.js

    • Download the macOS installer from the Node.js download page.
    • Run the installer and follow the instructions.
    • Verify the installation by opening Terminal and typing:
      node -v
      npm -v
  2. Clone the Repository

    • Open Terminal.
    • Navigate to the desired directory:
      cd /path/to/your/directory
    • Clone the repository:
      git clone https://github.com/singodiyashubham87/Draw-it-out.git
    • Navigate into the project directory:
      cd Draw-it-out
  3. Install Dependencies

    • Install the project dependencies by running:
      npm install
  4. Start the Application

    • Start the app in development mode:
      npm run dev

For Linux

  1. Install Node.js

    • Open Terminal.
    • Use the following commands to install Node.js (example for Ubuntu/Debian-based systems):
      curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash -
      sudo apt-get install -y nodejs
    • Confirm the installation by typing:
      node -v
      npm -v
  2. Clone the Repository

    • Navigate to the desired directory:
      cd /path/to/your/directory
    • Clone the repository:
      git clone https://github.com/singodiyashubham87/Draw-it-out.git
    • Navigate into the project directory:
      cd Draw-it-out
  3. Install Dependencies

    • Install the dependencies with:
      npm install
  4. Start the Application

    • Run the app in development mode:
      npm run dev

Features

  • Drawing Tools: Users can select between different drawing tools like pencil and brush thickness.
  • Color Picker: Choose from a wide range of colors using the color picker tool.
  • Shapes: Users can select from different shapes, like circles, triangles, and rectangles, to use in their drawings.
  • Brush Thickness: Adjust the thickness of the brush stroke using a range slider.
  • Snapshot: Capture and download snapshots of the whiteboard canvas.
  • Clear Canvas: Clear the canvas with a single click.
  • Responsive Design: The application is responsive and works seamlessly across different screen sizes.
  • Resizable Board: Adjust the height of the board using Increase and Decrease buttons.

Using Drawing Tools

  • Pencil: The pencil is selected by default in the app. Simply, move onto the canvas and start drawing.
  • Brush Thickness: This feature will allow you to select the thickness of the brush tool.
  • Color Picker: This feature will help to select a color of your choice. The user gets the option to select the color depending on three color models, namely, 'RGB', 'HSL' and 'HEX'. Optionally, the user can select any color on the screen as well, with the help of a color picker.
  • Snapshot: The snapshot option allows you to store your creativity in an image form(PNG).
  • Canvas Height: This feature will allow you to select the height of the canvas.

Tech Stack

  • ReactJS
  • TailwindCSS

Deployed App

https://draw-it-out.vercel.app/

Releases

  • Release 1.0 : March 15, 2024 @16:32 [First phase of application completed.]

    • Features: Added snapshot functionality and fixed minor bugs.
  • Release 0.0 : March 14, 2024 @22:31 [Zeroth phase of application completed.]

    • Features: Drawing functionality with custom thickness of the brush and custom color.

Contributions

You can find the contributing guideline here -> CONTRIBUTING GUIDELINES

Author

License

License: MIT

Thanks to all the Contributors

Thanks a lot for spending your time helping this project grow. Keep rocking!

Message from PA

Thank you for visiting Draw-it-out! ๐Ÿ’
Feel free to explore the code, contribute, and provide feedback.

draw-it-out's People

Contributors

singodiyashubham87 avatar gayathrithejus avatar prithwi32 avatar amish-khan avatar dependabot[bot] avatar leorasaharia avatar asl2027 avatar anandk-pm avatar chaithanyakrishna28 avatar the-phoenics avatar vidip-ghosh avatar tonystark-47 avatar shubhammjha22 avatar sivaprasath2004 avatar kumar1397 avatar harsh-kumarjha avatar 0xabdulkhalid avatar aaryaparadkar avatar jagpreet153 avatar spacedust26 avatar porwalshreyaa avatar atanu789 avatar shivamb11 avatar aslams2020 avatar rahulsingh1939 avatar stiffpixels avatar thatsyogeshjjr avatar suryapratapsingh26 avatar sanmarg avatar rushiljalal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.