SketchSync is a real-time collaborative whiteboard application designed to facilitate seamless collaboration and brainstorming among teams. This project is part of my ALX Software Engineering School portfolio.
The idea sprouted from a shared experience - the challenges of working together seamlessly, irrespective of physical boundaries. We envisioned a platform that would redefine collaborative work, bringing teams closer and enhancing creativity. SketchSync was born out of this vision, and it has been an exhilarating ride turning our dream into reality.
- Overview
- Features
- Getting Started
- Project Structure
- Running Locally
- Contributing
- Related Projects
- License
Welcome to SketchSync, a project inspired by our passion for fostering collaboration and breaking down the barriers of distance in creative endeavors. As a dedicated individual at ALX Software Engineering School, this project has been an exciting journey, fueled by our shared belief in the power of collaborative work. The idea sprouted from a shared experience - the challenges of working together seamlessly, irrespective of physical boundaries. We envisioned a platform that would redefine collaborative work, bringing teams closer and enhancing creativity. SketchSync was born out of this vision, and it has been an exhilarating ride turning our dream into reality.
- Real-time collaborative whiteboard
- User Authentication.
- Save whiteboard as image.
Before you begin, ensure you have the following installed:
# Clone the repository
git clone https://github.com/Osilaja78/SketchSync.git
# Move to the project directory
cd SketchSync
├── backend # Backend code (FastAPI) └── frontend # Frontend code (Next.js)
# Move to the frontend directory
cd frontend
# Install frontend dependencies
npm install
# Run the frontend application
npm start
# Move to the backend directory
cd backend
# Install backend dependencies
pip install -r requirements.txt
# Run the FastAPI server
uvicorn main:app --reload
Contributors - Hameed Osilaja
- Micorsoft Whteboard.
- Whteboard.team
Copyright (c) 2023 Osilaja Hameed
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.