https://github.com/sajjadmrx/whiteboard
A Real Time Whiteboard for the classroom to share ideas and notes
https://github.com/sajjadmrx/whiteboard
Last synced: about 1 month ago
JSON representation
A Real Time Whiteboard for the classroom to share ideas and notes
- Host: GitHub
- URL: https://github.com/sajjadmrx/whiteboard
- Owner: sajjadmrx
- Created: 2022-01-19T22:01:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-20T13:54:07.000Z (over 3 years ago)
- Last Synced: 2025-03-24T05:11:21.266Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://whiteboardts.herokuapp.com
- Size: 34.2 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Title
A brief description of what this project does and who it's for
# whiteboard
A Real Time Whiteboard for the classroom to share ideas and notes
## Index
+ [Demo](#demo)
+ [Features](#features)
+ [Installation](#installation)
+ [Screenshots](#screenshots)
## Demo
Check Deme [click here](https://whiteboardts.herokuapp.com/)
## Features
+ Uses Express as the application Framework.
+ Real-time communication between a client and a server using [Socket.io](https://github.com/socketio/socket.io).
## Installation
### Running Locally
Make sure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
1. Clone or Download the repository
```
$ git clone https://github.com/sajjadmrx/whiteboard.git
$ cd whiteboard
```
2. Install Dependencies
```
$ npm install
```
3. configure .env file
```
PORT = 3000
```
3. Start the application
```
$ npm start
```
Your app should now be running on [localhost:3000](http://localhost:3000/).
# Screenshots
