https://github.com/dhruvpatidar359/nextdraw
A WhiteBoard application used for prototyping supports Websockets
https://github.com/dhruvpatidar359/nextdraw
docker mongodb nextjs14 react vscode websocket
Last synced: 2 months ago
JSON representation
A WhiteBoard application used for prototyping supports Websockets
- Host: GitHub
- URL: https://github.com/dhruvpatidar359/nextdraw
- Owner: dhruvpatidar359
- License: mit
- Created: 2024-01-12T11:10:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-07T15:56:33.000Z (10 months ago)
- Last Synced: 2024-10-08T10:05:41.474Z (6 months ago)
- Topics: docker, mongodb, nextjs14, react, vscode, websocket
- Language: JavaScript
- Homepage: https://nextdraw.vercel.app
- Size: 526 KB
- Stars: 47
- Watchers: 1
- Forks: 29
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT
Awesome Lists containing this project
- my-awesome-list - nextdraw
README
# 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
## Features🎨
- RECORDING ✅
- Middle Mouse Click ToolBar 🖱️
- 
- Collaboration(Websockets) 🤝
- Supports various shapes: Rectangle , square , ellipse , freehand , etc .
### Built With 🛠️
- [Next.js]()
- [Canvas API]()
- [MongoDb]()
- [Node.js]()
- [Websockets]()
## 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 📂
- Frontend
https://github.com/dhruvpatidar359/nextdraw
- Backend
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
```bash
use the github fork button
```
2. 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
```bash
NEXT_PUBLIC_WEB_SOCKET= url of the server
```
3. Install DependenciesNavigate to the project directory in your terminal and run:
```bash
npm install
# or
yarn install
```
4. Start the Development ServerAfter installing dependencies, run:
```bash
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💖.