Go to file
David Négrier 5a56604038 Adding documentation page regarding editing your own map
This commit adds a new documentation page to the website explaining how to create your own map.
2020-07-05 19:08:37 +02:00
.github/workflows Enabling optional https in development 2020-06-25 10:32:47 +02:00
back Removing host label from Prometheus because it is redundant 2020-06-29 23:01:52 +02:00
e2e fixed the version mismatch of cypress between local and ci 2020-04-14 20:54:27 +02:00
front Fixing loading of tilesets with margin or padding 2020-07-05 17:10:08 +02:00
website Adding documentation page regarding editing your own map 2020-07-05 19:08:37 +02:00
.env.template create an env variable for debug mode 2020-04-13 19:40:10 +02:00
.gitignore Add story of Leymah to landing page 2020-06-14 11:32:15 +02: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 Add Vagrantfile 2020-04-04 04:33:57 +02:00
deeployer.libsonnet Adding version number to Deeployer 2020-06-25 12:07:43 +02: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 Fixing hot reloading 2020-06-25 10:43:10 +02: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.