Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lambels committed Jun 1, 2022
1 parent b47c8a4 commit 1e7f3b5
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This project was made to refresh my memory on websockets and on centralised hubs
![demo giphy](demo.gif)

# Run
> Must have go installed.
### Step 1: [Fork the repo](https://github.com/Lambels/drawing-app/fork).
### Step 2: Run the server.
Mac/Linux
Expand All @@ -19,4 +20,20 @@ go run .
```
### Step 3: Open as many clients.
Open the [index.html](client/index.html) file in your browser as done in the demo.
> Note: Each client gets assigned a random and unique color.
# Run (Docker)
> Must have docker installed.
### Step 1: Clone the repo
### Step 2: Build the docker image from source:
```
docker build -t drawing-app ./path/to/dockerfile
```
### Step 3: Run a docker container:
```
docker run -p 8080:8080 drawing-app
```
> `Ctrl-c` to quit
### Step 4: Open as many clients.
Open the [index.html](client/index.html) file in your browser as done in the demo.
> Note: Each client gets assigned a random and unique color.

0 comments on commit 1e7f3b5

Please sign in to comment.