Go to file
_Bastler d12f89dfb5 fix emoji 2022-05-12 09:29:18 +02:00
.github/workflows fix desktop app releasing (#2116) 2022-04-25 10:18:13 +02:00
.husky Adding Prettier in messages 2021-12-16 16:40:50 +01:00
back Merge branch 'develop' of github.com:thecodingmachine/workadventure into develop 2022-05-12 09:02:34 +02:00
benchmark availabilityStatus info from websocket 2022-05-11 11:27:52 +02:00
contrib/docker Adding a proper README to the production docker-compose directory 2022-04-22 17:57:36 +02:00
desktop Bump ejs from 3.1.6 to 3.1.7 in /desktop/electron (#2145) 2022-05-08 16:55:13 +02:00
docs Add swagger doc for the link pusher -> admin (#2146) 2022-05-11 17:43:25 +02:00
front fix emoji 2022-05-12 09:29:18 +02:00
maps Add disable proximity meeting test map 2022-05-11 15:28:39 +02:00
messages Change map details params (#2192) 2022-05-11 18:03:47 +02:00
pusher Merge branch 'develop' of github.com:thecodingmachine/workadventure into develop 2022-05-12 09:03:01 +02:00
tests Adding test to check custom menus 2022-04-26 18:06:07 +02:00
uploader Merge branch 'develop' of github.com:thecodingmachine/workadventure into develop 2022-05-11 11:42:32 +02:00
.dockerignore *: Dockerfiles cleanup, docker-compose.prod.yaml 2021-01-12 22:32:37 +01:00
.env.template Merge branch 'develop' of github.com:thecodingmachine/workadventure 2021-11-16 10:56:33 +01:00
.gitignore merge develop_vite 2022-02-27 14:39:06 +01:00
CHANGELOG.md Add multi co website to the changelog 2021-10-27 09:47:15 +02:00
CONTRIBUTING.md Fixed discord links 2022-02-28 21:07:36 +01:00
README.md Fixed discord links 2022-02-28 21:07:36 +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 Add OPID env (#2076) 2022-04-12 11:44:22 +02:00
docker-compose.e2e.yml Refactoring Woka management (#1810) 2022-03-11 17:02:58 +01:00
docker-compose.prod.yaml Merge branch 'develop' of github.com:thecodingmachine/workadventure into develop 2022-02-28 19:12:42 +01:00
docker-compose.single-domain.yaml Update all docker nodejs container to the last LTS (16) 2022-05-10 12:03:22 +02:00
docker-compose.yaml Update all docker nodejs container to the last LTS (16) 2022-05-10 12:03:22 +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 New select woka scene (#1997) 2022-04-22 17:56:28 +02:00
yarn.lock yarn.lock update 2022-02-07 13:47:33 +01:00

README.md

This is a fork of WorkAdventure with some adjustment and changes for production environment for Bastelei e. V. Partey

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 production environment of Partey is based on a single-domain deployment with some changed, minimized Dockerfiles based on the fork workadventure-xce. An example can be found in contrib/docker/docker-compose.single-domain.prod.yaml. To create a non-single-domain based environment, please adopt settings from the below WorkAdventure provided file yourself. The changed Dockerfiles won't work directly with the file below!

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.