https://github.com/farukseker/mini-r-place

Mini R-Place Event APP
https://github.com/farukseker/mini-r-place

clone-website fastapi r-place redis redit rplace vue vue3 vuejs websocket

Last synced: about 2 months ago
JSON representation

Mini R-Place Event APP

• Host: GitHub
• URL: https://github.com/farukseker/mini-r-place
• Owner: farukseker
• Created: 2025-05-06T02:01:51.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-06T03:41:55.000Z (about 1 year ago)
• Last Synced: 2025-05-07T03:52:49.112Z (about 1 year ago)
• Topics: clone-website, fastapi, r-place, redis, redit, rplace, vue, vue3, vuejs, websocket
• Language: Vue
• Homepage:
• Size: 238 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Mini rPlace

Mini rPlace is a small-scale r/place clone where you and your friends can paint pixels together in real time. It is built with FastAPI, Vue.js, and Redis, and can be easily set up and run with Docker.

[![Project Banner](.preview/banner_with_play_btn.png)](https://youtu.be/BSK8Dn7GpaQ)

> // preview ![choose a color](.preview/choose_a_color.png)

## Features

- Real-time, multi-user mini canvas (e.g. 50x50)

- Instant updates via WebSocket

- Modern and user-friendly Vue.js interface

- Color selection with modal and palette

- Easy setup with Docker Compose

## Use Case

You can organize a mini rPlace event with your friends, paint pixels together, and create fun maps. Everyone can join from their own device and see changes instantly.

## Installation

### Requirements

- Docker

- Docker Compose

### Steps

1. **Clone the project:**

   ```bash

   git clone 

   cd MiniPlace

   ```

2. **Start all services:**

   ```bash

   docker-compose up --build

   ```

3. **Access the app:**

   - Frontend (Vue interface): [http://localhost:8080](http://localhost:8080)

   - Backend (API): [http://localhost:8000/docs](http://localhost:8000/docs)

4. **Invite your friends:**

   Everyone can join the same address in their browser and collaborate on the canvas together.

## Developer Notes

- Canvas size and color palette can be easily customized.

- Real-time updates are provided via WebSocket, no extra refresh needed.

- The codebase is written with FastAPI (Python) and Vue 3 (JavaScript).

## Contribution & License

Feel free to open a PR or issue if you want to contribute. For license information, please contact the project owner.

---

**Start your own mini rPlace event and have fun together!**