add readme wip

main
km0 2 years ago
parent a933d2116f
commit 042fd52ad7

@ -1 +0,0 @@
web npm start

@ -0,0 +1,33 @@
# DRW
![Drawing a bird](cover.jpg)
A small app for collecting drawings in real time. Runs on a small express server that connects sources (where to draw) and destinations (where to display) via websockets.
_(hei! this is still work in progress! currently adapting some aspects in the server in order to: a. make it more general, and not strictly related to vvvv, and b. make it possible to have more destinations connected to receive the drawings at the same time)_
## Setup
Clone the repo , move to the directory and install the dependencies using your favourite package manager ([npm](https://www.npmjs.com/), [yarn](https://yarnpkg.com/), etc.).
Note that to run the app you will need to install [Node.js](https://nodejs.org/en/), either on your machine or on a VPS.
For example with npm:
```
git clone https://git.xpub.nl/kamo/drw
cd drw
npm install
```
To start the application run
`node server.js`
or in alternative
`npm start`
Then open your browser to `localhost:3000` and there you can draw.
The app is meant to be open-end, meaning that the destination of the drawing is up to you! (ah ah! less work for us). Originally it was coupled with [vvvv](https://visualprogramming.net/), but it can be implemented with any platform supporting the websocket protocol.

Binary file not shown.

After

Width:  |  Height:  |  Size: 622 KiB

Loading…
Cancel
Save