Go to file
David Négrier fff45c2f92 Adding prettier on messages 2021-12-16 16:27:44 +01:00
.github/workflows Fixing CI with new messages 2021-12-16 16:15:12 +01:00
.husky Setting up lint-staged on front and back 2021-06-23 16:45:38 +02:00
back Merge pull request #1616 from Waclaw-I/feature-camera-zone-focus 2021-12-14 15:43:45 +01: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 Adding missing environment variable in docker-compose.prod.yml 2021-11-30 15:02:52 +01:00
docs Merge pull request #1652 from thecodingmachine/small_doc_improve 2021-12-16 10:09:45 +01:00
front Adding JsonMessages to Docker image 2021-12-16 16:09:59 +01:00
maps Merge pull request #1649 from ValdoTR/fix/test-skins 2021-12-15 17:43:35 +01:00
messages Adding prettier on messages 2021-12-16 16:27:44 +01:00
pusher Fixing wrong import 2021-12-16 16:18:23 +01:00
tests Fixing admin token for requests 2021-12-06 16:37:27 +01: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 Fix feedback @moufmouf 2021-11-15 15:58:08 +01:00
.gitignore added husky to gitignore 2021-06-25 18:07:03 +02:00
CHANGELOG.md Add multi co website to the changelog 2021-10-27 09:47:15 +02:00
CONTRIBUTING.md Adding a reference to awesome-workadventure in CONTRIBUTING 2021-12-09 18:08:04 +01: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 Adding a reference to awesome-workadventure in README 2021-12-09 18:10:30 +01: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
deeployer.libsonnet Fixed potential injection by switching map container to PHP 2021-11-29 19:05:13 +01:00
docker-compose.single-domain.yaml Merge branch 'master' of github.com:thecodingmachine/workadventure into develop 2021-11-30 15:13:36 +01:00
docker-compose.testcafe.yml Fixing admin token for requests 2021-12-06 16:37:27 +01:00
docker-compose.yaml Fixing docker-compose up linking to wrong directory when started in container 2021-12-04 23:17:07 +01: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 Revert "Improving log messages" 2021-11-24 16:20:07 +01:00
yarn.lock Revert "Improving log messages" 2021-11-24 16:20:07 +01:00

README.md

Discord

WorkAdventure logo WorkAdventure office image

Live demo here.

WorkAdventure

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

Community resources

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

Setting up a development environment

Install Docker.

Run:

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

127.0.0.1 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.localhost 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.

Prerequisites

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.