Live demo here.

WorkAdventure (THE PIER / HACKCLUB EDITION)

WorkAdventure is a web-based collaborative workspace presented in the form of a 16-bit video game.

We plan to make our fork of WorkAdventure an awesome hangout & work space for Hack Clubbers

This will be used for one of the next Big HQ Projects™!

In WorkAdventure you can move around your office and talk to your colleagues (using a video-chat system, triggered when you approach someone).

See more features for your virtual office: https://workadventu.re/virtual-office

Community resources

Check out resources developed by the WorkAdventure community at awesome-workadventure

Setting up a production environment

We support 2 ways to set up a production environment:

• using Docker Compose
• or using a Helm chart for Kubernetes

Please check the Setting up a production environment guide for more information.

Setting up a development environment on GitHub Codespaces

First, create a Codespace on this repository. Click the green Code button, select Codespaces, and press "Create codespace on master". That's it! A dev environment will be set up for you automatically.

For reference, this is the command used to run everything in Codespaces.

docker compose -f docker-compose-base.yaml -f docker-compose-codespaces.yaml up --force-recreate

Setting up a development environment locally

Note

These installation instructions are for local development only. They will not work on remote servers as local environments do not have HTTPS certificates.

Install Docker and clone this repository.

Warning

If you are using Windows, make sure the End-Of-Line character is not modified by the cloning process by setting the core.autocrlf setting to false: git config --global core.autocrlf false

Run:

cp .env.template .env
docker compose -f docker-compose-base.yaml -f docker-compose-dev.yaml up --force-recreate

The environment will start.

You should now be able to browse to http://play.workadventure.localhost/ and see the application. You can view the Traefik dashboard at http://traefik.workadventure.localhost

Note: on some OSes, you will need to add this line to your /etc/hosts file:

/etc/hosts

127.0.0.1 oidc.workadventure.localhost redis.workadventure.localhost play.workadventure.localhost traefik.workadventure.localhost matrix.workadventure.localhost extra.workadventure.localhost icon.workadventure.localhost map-storage.workadventure.localhost uploader.workadventure.localhost maps.workadventure.localhost api.workadventure.localhost front.workadventure.localhost

You can also start WorkAdventure + a test OpenID connect server using:

$ docker-compose -f docker-compose.yaml -f docker-compose-oidc.yaml up

(Test user is "User1" and his password is "pwd")

This is potentially a pathway to implement Sign in with Slack

Troubleshooting

See our troubleshooting guide.