Scribble.rs

This project is intended to be a clone of the web-based drawing game skribbl.io. In my opinion skribbl.io has several usability issues, which I'll try addressing in this project.

Even though there is an official instance at scribble.rs, you can still host your own instance.

The site will not display any ads or share any data with third parties.

Building / Running

Run the following to build the application:

Install Go, Yarn.

# after cloning this repository...
go mod tidy

# bundle webpack
make bundle 

# build the go binary
make build

# run tests
make test

# run locally
make up

# dockerize
make dockerize

# push docker image to docker repository
make push

This will produce a portable binary called scribblers. The binary doesn't have any dependencies and should run on every system as long as it has the same architecture and OS family as the system it was compiled on.

Configuration via Environment Variables

HTTP_PORT defaults to 8080

REDIS_ADDR defaults to 127.0.0.1:6379

AGORA_APP_ID defaults to 89f97462e28540e68a6a90760c9ca113 ... get one at https://www.agora.io/en/

AGORA_CERT

Contributing

There are many ways you can contribute:

Update / Add documentation in the wiki of the GitHub repository
Extend this README
Create issues
Solve issues by creating Pull Requests
Tell your friends about the project
Curating the word lists

Connected Canadians setups

Install go
Install CompileDaemon go get github.com/githubnemo/CompileDaemon
./run.sh
When you make changes to any file, refresh your browser tab http://localhost:8080/

Credits