Go to file
David Négrier 686427f6fe Merge branch 'develop' of github.com:thecodingmachine/workadventure into fix/deploy-cleanup
# Conflicts:
#	front/Dockerfile
2021-02-01 14:00:07 +01:00
.github/workflows remove cypress from the project :( 2021-01-28 14:56:24 +01:00
back Merge branch 'develop' of github.com:thecodingmachine/workadventure into fix/deploy-cleanup 2021-02-01 14:00:07 +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
front Merge branch 'develop' of github.com:thecodingmachine/workadventure into fix/deploy-cleanup 2021-02-01 14:00:07 +01:00
maps Merge branch 'develop' of github.com:thecodingmachine/workadventure into fix/deploy-cleanup 2021-02-01 14:00:07 +01:00
messages Merge branch 'develop' of github.com:thecodingmachine/workadventure into fix/deploy-cleanup 2021-02-01 14:00:07 +01:00
pusher Merge branch 'develop' of github.com:thecodingmachine/workadventure into fix/deploy-cleanup 2021-02-01 14:00:07 +01:00
uploader *: Dockerfiles cleanup, docker-compose.prod.yaml 2021-01-12 22:32:37 +01:00
website Merge branch 'develop' of github.com:thecodingmachine/workadventure into fix/deploy-cleanup 2021-02-01 14:00:07 +01:00
.dockerignore *: Dockerfiles cleanup, docker-compose.prod.yaml 2021-01-12 22:32:37 +01:00
.env.template Simplifying code and making START_ROOM_URL compatible with public (_) and private (@) paths 2021-01-21 09:40:11 +01: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 Removing admin from develop branch because of issue with SSL certificate 2021-01-28 23:18:12 +01:00
docker-compose.prod.yaml *: Dockerfiles cleanup, docker-compose.prod.yaml 2021-01-12 22:32:37 +01:00
docker-compose.yaml Merge pull request #632 from thecodingmachine/feat/url-room-started 2021-01-21 10:10:22 +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.