unicornpaint

A web-based painting app for raspberry PI and pimoroni Unicorn Hat HD
Log | Files | Refs | README

README.md (1509B)

      1 ## Moved! ## 
      2 
      3 This code has moved to https://code.mfashby.net/code/var/fossil/unicornpaint
      4 
      5 # Unicorn Paint
      6 A painting webapp, controlling a [16x16 LED matrix](https://shop.pimoroni.com/products/unicorn-hat-hd). It allows multiple people to paint at once & updates in real time.
      7 
      8 This project includes the following components:
      9 * A [Go library](https://github.com/MFAshby/unicornpaint/tree/master/unicorn) for controlling the physical device 
     10 * A [Go web server](https://github.com/MFAshby/unicornpaint/blob/master/Server.go) utilising websocket communication
     11 * A [React JS client application](https://github.com/MFAshby/unicornpaint/tree/master/src)
     12 * Distribution & deployment with [Docker](https://github.com/MFAshby/unicornpaint/blob/master/Dockerfile)
     13 
     14 Live example hosted at:
     15 https://unicorn.mfashby.net
     16 
     17 ![screenshot](https://github.com/MFAshby/unicornpaint/raw/master/Screenshot.png "Screenshot")
     18 
     19 ## Running
     20 Ensure SPI is enabled on your raspberry pi:
     21 ```
     22 sudo raspi-config nonint do_spi 0
     23 sudo reboot
     24 ```
     25 
     26 Run with docker:
     27 ```
     28 docker pull mfashby/unicornpaint
     29 docker run --device /dev/spidev0.0:/dev/spidev0.0 --publish 3001:3001 mfashby/unicornpaint
     30 ```
     31 
     32 Or download the [docker-compose](https://raw.githubusercontent.com/MFAshby/unicornpaint/master/docker-compose.yml) file and run with 
     33 ```
     34 docker-compose up -d
     35 ```
     36 
     37 Or install Go, clone the repository & run directly with 
     38 ```
     39 go get github.com/ecc1/spi github.com/gorilla/websocket github.com/MFAshby/unicornpaint/unicorn
     40 go run Server.go
     41 ```