44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
# Collaborative Pixel Art
|
|
|
|
Collaborative Pixel Art is a web application that allows multiple users to collaboratively create pixel art on a shared canvas in real-time.
|
|
|
|
## Setup Instructions
|
|
|
|
To set up the project, follow these steps:
|
|
|
|
1. **Clone the repository:**
|
|
|
|
```bash
|
|
git clone https://github.com/elektricm/collaborative-pixel-art.git
|
|
```
|
|
|
|
2. **Install Dependencies:**
|
|
|
|
Make sure you have Node.js and npm (Node Package Manager) installed on your system. Then, install the project dependencies by running in the project folder:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. **Start the server:**
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
or
|
|
|
|
```bash
|
|
node server.js
|
|
```
|
|
|
|
4. **Open the application in your browser:**
|
|
|
|
Open the following URL in your browser: [http://localhost:3000](http://localhost:3000)
|
|
|
|
## Features
|
|
|
|
Usage
|
|
Each user can select a color from the color selector on the right side of the canvas.
|
|
To place a pixel on the canvas, simply click on the desired grid cell using the selected color.
|
|
All connected users will see the changes in real-time as pixels are placed or updated on the canvas.
|