Go to file
Valdo f6fcb37d91
Updated README (logo, map, wording) (#1485)
Co-authored-by: Valdo Romao <v.romao@thecodingmachine.com>
2021-10-02 15:59:45 +02:00
.github/workflows Fixing Posthog env var 2021-09-16 17:03:49 +02:00
.husky Setting up lint-staged on front and back 2021-06-23 16:45:38 +02:00
back Bump axios from 0.21.1 to 0.21.2 in /back 2021-09-20 12:34:04 +00:00
benchmark Bump path-parse from 1.0.6 to 1.0.7 in /benchmark 2021-09-01 15:48:20 +00:00
contrib/docker [Breaking change] UPLOADER_URL and ADMIN_URL are now true URLs (and not only host name) and API_URL is replaced by PUSHER_URL 2021-03-31 16:00:14 +02:00
docs Merge branch 'master' of github.com:thecodingmachine/workadventure 2021-09-16 16:46:27 +02:00
front Remove audio manager range volume control by keys (#1489) 2021-10-02 15:55:54 +02:00
maps Removed old maps and add starter-kit map 2021-09-23 12:29:14 +01:00
messages Release v1.4.15 (#1411) 2021-09-05 19:51:33 +02:00
pusher Manage redirect URL from admin and save in hydra via pusher (#1492) 2021-09-30 11:16:25 +02:00
uploader Bump path-parse from 1.0.6 to 1.0.7 in /uploader 2021-09-01 13:10:13 +00:00
.dockerignore *: Dockerfiles cleanup, docker-compose.prod.yaml 2021-01-12 22:32:37 +01:00
.env.template Merge pull request #1480 from ValdoTR/maps 2021-09-24 10:58:31 +02:00
.gitignore added husky to gitignore 2021-06-25 18:07:03 +02:00
CHANGELOG.md Updating Changelog 2021-09-16 16:46:48 +02:00
CONTRIBUTING.md setProperty function doesn't set an empty array if property doesn't exist 2021-07-02 14:40:18 +02:00
deeployer.libsonnet FIX: removed admin url from deeployer on develop and master and changed starter map 2021-09-30 11:51:41 +02:00
docker-compose.single-domain.yaml FIX: bomp the node version of pusher 2021-07-30 15:50:30 +02:00
docker-compose.yaml FIX: bomp the node version of pusher 2021-07-30 15:50:30 +02:00
package-lock.json Merge remote-tracking branch 'remotes/upstream/develop' into trigger-message-refv3 2021-07-02 18:49:22 +02:00
package.json Update package.json (#1344) 2021-08-09 14:36:53 +02:00
README-LOGO.svg Updated README (logo, map, wording) (#1485) 2021-10-02 15:59:45 +02:00
README-MAP.png Updated README (logo, map, wording) (#1485) 2021-10-02 15:59:45 +02:00
README.md Updated README (logo, map, wording) (#1485) 2021-10-02 15:59:45 +02:00
SECURITY.md Create SECURITY.md 2021-06-23 15:26:17 +02:00
Vagrantfile.template Update vagrant template 2020-12-16 16:39:34 +01:00
yarn.lock Merging master into develop 2021-06-29 18:39:43 +02:00


WorkAdventure logo WorkAdventure office image

Live demo here.


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

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

Setting up a development environment

Install Docker.


cp .env.template .env
docker-compose up -d

The environment will start.

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

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

/etc/hosts workadventure.localhost

Note: If on the first run you get a page with "network error". Try to docker-compose stop , then docker-compose start. Note 2: If you are still getting "network error". Make sure you are authorizing the self-signed certificate by entering https://pusher.workadventure.testing and accepting them.

MacOS developers, your environment with Vagrant

If you are using MacOS, you can increase Docker performance using Vagrant. If you want more explanations, you can read this medium article.


First steps

Create a config file Vagrantfile from Vagrantfile.template

cp Vagrantfile.template Vagrantfile

In Vagrantfile, update VM_HOST_PATH with the local project path of your machine.

#VM_HOST_PATH# => your local machine path to the project

(run pwd and copy the path in this variable)

To start your VM Vagrant, run:

Vagrant up

To connect to your VM, run:

Vagrant ssh

To start project environment, run

docker-compose up

You environment runs in you VM Vagrant. When you want stop your VM, you can run:

Vagrant halt

If you want to destroy, you can run

Vagrant destroy

Available commands

  • Vagrant up: start your VM Vagrant.
  • Vagrant reload: reload your VM Vagrant when you change Vagrantfile.
  • Vagrant ssh: connect on your VM Vagrant.
  • Vagrant halt: stop your VM Vagrant.
  • Vagrant destroy: delete your VM Vagrant.

Setting up a production environment

The way you set up your production environment will highly depend on your servers. We provide a production ready docker-compose file that you can use as a good starting point in the contrib/docker directory.