Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prokawsar/whiteboard
https://github.com/prokawsar/whiteboard
express nodejs socket-io svelte sveltekit typescirpt
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/prokawsar/whiteboard
- Owner: prokawsar
- Created: 2024-11-08T06:58:31.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-11T02:34:35.000Z (about 2 months ago)
- Last Synced: 2024-11-11T03:23:40.511Z (about 2 months ago)
- Topics: express, nodejs, socket-io, svelte, sveltekit, typescirpt
- Language: TypeScript
- Homepage: https://whiteboard-pi-nine.vercel.app
- Size: 210 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Whiteboard Project
## Overview
This project is a collaborative whiteboard application that allows users to draw, write, and share ideas in real-time. It is designed to facilitate brainstorming sessions, online classes, and creative collaboration.
## Features
- Real-time drawing and writing
- User authentication
- Save and load whiteboard sessions
- Collaborative features for multiple users## Technologies Used
- Frontend: Svelte, SvelteKit
- Backend: Node.js with Express
- Database: MongoDB
- WebSocket for real-time communication## Prerequisites
Before you begin, ensure you have the following installed:
- Node.js (v18 or higher)
- MongoDB (local or cloud instance)## Setup Instructions
### 1. Clone the Repository
```bash
git clone https://github.com/prokawsar/whiteboard.gitcd whiteboard
```
### 2. Install Dependencies
Navigate to both the frontend and backend directories and install the necessary packages.
## Backend and Frontend
```bash
npm i
cd server
npm i```
## Start
```bash
cd ../
npm run dev
```