Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
kapilreddy committed Oct 7, 2024
1 parent 572bb43 commit f054873
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# (r/place)

A real-time, collaborative pixel art platform inspired by Reddit's r/place, implemented in Clojure and ClojureScript.

# Constraints / design choices
- No database, delibrately not to use a database or external dependency. This will help us highlight some of the goodness Clojure has to offer.
- Project aims to host only one global canvas.

# Architecture

Backend is a HTTP-kit server which serves both HTTP and WebSockets requests.

```mermaid
sequenceDiagram
participant A as "UI (Clojurescript)"
participant B as "Backend (Clojure)"
B-->>A: HTTP: Render UI
B-->>A: WS: Send canvas
B-->>A: WS: Send canvas updates
A-->>B: WS: Send canvas update
# Dev setup - WIP

0 comments on commit f054873

Please sign in to comment.