Skip to content

Latest commit

 

History

History
127 lines (81 loc) · 3.05 KB

README.md

File metadata and controls

127 lines (81 loc) · 3.05 KB
Raw

Welcome to NextDraw🎨

A Next.js based whiteboard application using Rough.js under the hood .

  • Supports websockets
  • Supports shapes like : rectangle || square || ellipse || freehand etc
  • Record feature
  • Pan | zoom and lot more . Just click on the hosted link.

Table of Contents

  • Project Introduction
  • Features
  • Built with
  • Contributing
  • GSSOC'24 Guidelines
  • Local Setup
  • License
  • Contact

Screenshots

image

Features🎨

  • RECORDING ✅
image

  • Middle Mouse Click ToolBar 🖱️

  • image

  • Collaboration(Websockets) 🤝

image

  • Supports various shapes: Rectangle , square , ellipse , freehand , etc .

Built With 🛠️

Contributing 🚀

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  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

GSSOC'24 Guidelines

  • Issues Level

    • Level 1: 10 points
    • Level 2: 25 points
    • Level 3: 45 points

  • Issue Assignment

    • Remember assigning an issue to someone does not means that he is the only person to contribute on that particular issue . Other persons can also make PR to that particular issue .

Repositories 📂

https://github.com/dhruvpatidar359/nextDrawBackend

Installation(LOCAL SETUP)

WARNING : First install the backend through this repository https://github.com/dhruvpatidar359/nextDrawBackend

FrontEnd Installation

  1. Fork the Project
  use the github fork button
  1. Create a .env.local file in the directory and create the below field: Put the url of the locally hosted server that we have created before
 NEXT_PUBLIC_WEB_SOCKET= url of the server
  1. Install DependenciesNavigate to the project directory in your terminal and run:
  npm install
  # or
  yarn install
  1. Start the Development ServerAfter installing dependencies, run:
 npm run dev
 # or
 yarn dev

Remember that this project uses .env for both the backend and frontend part

License 📜

Distributed under the MIT License. See LICENSE for more information.

Contact 📧

dhruvpatidar - [email protected]

We appreciate your contributions and look forward to collaborating with you!! Thank you for contributing . Happy Coding💖.