https://github.com/pranay-0512/codesk
coCanvas: A collaborative whiteboard canvas where users can seamlessly collaborate in real-time, sketch ideas, brainstorm, and visualize concepts together. Plus, built-in version control ensures seamless tracking of changes and easy collaboration.
https://github.com/pranay-0512/codesk
Last synced: 3 months ago
JSON representation
coCanvas: A collaborative whiteboard canvas where users can seamlessly collaborate in real-time, sketch ideas, brainstorm, and visualize concepts together. Plus, built-in version control ensures seamless tracking of changes and easy collaboration.
- Host: GitHub
- URL: https://github.com/pranay-0512/codesk
- Owner: pranay-0512
- Created: 2024-02-20T11:54:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-19T08:43:02.000Z (about 1 year ago)
- Last Synced: 2024-12-27T18:17:05.347Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 337 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
Awesome Lists containing this project
README
# coCanvas
coCanvas is a collaborative whiteboard canvas web application that allows users to work together in real-time on a digital canvas. It is designed to facilitate teamwork, brainstorming sessions, and visual collaboration among distributed teams.
## Features
- Real-time collaboration: Multiple users can sketch, annotate, and collaborate simultaneously on the same canvas.
- Drawing tools: A variety of drawing tools , shapes, and colors are available to facilitate creativity.
- Automatically saves locally to continue where you left off!
- Create your own version control with a click of a button. Snapshots can be edited and used for later.
- Infinite Canvas: There's no restriction to your creativity.
## Technologies Used
- Angular: Frontend framework for building the user interface and handling client-side logic.
- FastAPI: Backend framework for building the API server and handling server-side logic.
- Websockets: Used for real-time communication between clients and the server.
- Database: To be decided later. (Sticking with NoSQL MongoDB).
## Installation
To run coCanvas locally, follow these steps (client):
1. Clone this repository: `git clone https://github.com/pranay-0512/codesk.git`
2. Navigate to the project directory: `cd codesk`
3. Install dependencies:
- Take a pull from main branch
- `npm install`
4. Start the development with
- `ng serve -o`
## Contributing
Contributions are welcome! If you'd like to contribute to coCanvas, please fork the repository, make your changes, and submit a pull request. Be sure to follow the contribution guidelines outlined in CONTRIBUTING.md.
## License
This project is licensed under the [MIT License](LICENSE).
## Acknowledgements
Special thanks to the creators and contributors of Angular, FastAPI, Websockets, and PostgreSQL for providing the tools and technologies that power coCanvas.
## Contact
For questions, feedback, or support, please contact ``` [email protected] ```.