Go to file
Gregoire Parant 3e6aa84749 Update vagrant template 2020-12-16 16:39:34 +01:00
.github/workflows Merge branch 'master' of github.com:thecodingmachine/workadventure into scaling 2020-12-11 13:00:11 +01:00
back Making HTTP and GRPC ports configurable in API server 2020-12-14 22:43:05 +01:00
benchmark Improving benchmark measures 2020-12-04 15:13:46 +01:00
docs Adding a Pusher container as a middleware/dispatcher between front and back 2020-11-26 17:53:30 +01:00
e2e fixed the version mismatch of cypress between local and ci 2020-04-14 20:54:27 +02:00
front Fix style button 2020-12-16 16:32:28 +01:00
maps Fix some issues on map 2020-12-11 09:04:09 +01:00
messages Merge pull request #478 from thecodingmachine/dependabot/npm_and_yarn/messages/ini-1.3.7 2020-12-11 16:56:31 +01:00
pusher Add scaling capability to the API servers with this one weird trick 2020-12-14 22:20:43 +01:00
uploader Fixing Uploader build 2020-12-11 12:37:11 +01:00
website update pointer style 2020-12-15 17:31:55 +01:00
.env.template Deploying with new configurable Jitsi conf 2020-10-19 12:07:05 +02:00
.gitignore added: mate bottle accessorie 2020-11-20 11:49:08 +01:00
README-INTRO.jpg Adding demo to README 2020-06-14 12:33:23 +02:00
README.md Adding documentation page regarding editing your own map 2020-07-05 19:08:37 +02:00
Vagrantfile.template Update vagrant template 2020-12-16 16:39:34 +01:00
deeployer.libsonnet Load balancing preprod API back servers 2020-12-14 23:12:51 +01:00
docker-compose.ci.yml fixed the version mismatch of cypress between local and ci 2020-04-14 20:54:27 +02:00
docker-compose.yaml Merge branch 'master' of github.com:thecodingmachine/workadventure into scaling 2020-12-11 13:00:11 +01:00

README.md

WorkAdventure landscape image

Demo here : https://workadventu.re/.

Work Adventure

Work in progress

Work Adventure is a web-based collaborative workspace for small to medium teams (2-100 people) presented in the form of a 16-bit video game.

In Work Adventure, you can move around your office and talk to your colleagues (using a video-chat feature that is triggered when you move next to a colleague).

Getting started

Install Docker.

Run:

docker-compose up

The environment will start.

You should now be able to browse to http://workadventure.localhost/ and see the application.

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

/etc/hosts

workadventure.localhost 127.0.0.1

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.

Features developed

You have more details of features developed in back README.md.