Add Vagarnt in project RADME and fix feeback @moufmouf
authorgparant <g.parant@thecodingmachine.com>
Sat, 4 Apr 2020 09:36:18 +0000 (11:36 +0200)
committergparant <g.parant@thecodingmachine.com>
Sat, 4 Apr 2020 09:36:18 +0000 (11:36 +0200)
README.md
back/package.json
docker-compose.yaml

index 9aa843fa378d3b2ed6e73b02b3e8550396db8685..0e86a8751467df73de4a935721cfac627c615faf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -30,3 +30,48 @@ Note: on some OSes, you will need to add this line to your `/etc/hosts` file:
 workadventure.localhost 127.0.0.1
 ```
 
+## MacOs developer, your environment with Vagrant
+Increase Docker Performance with Vagrant. If you want more explain you can read: [this medium article](https://medium.com/better-programming/vagrant-to-increase-docker-performance-with-macos-25b354b0c65c).
+### Prerequisites
+- VirtualBox*  5.x     Latest version  https://www.virtualbox.org/wiki/Downloads
+- Vagrant      2.2.7   Latest version  https://www.vagrantup.com/downloads.html
+### First steps
+Create config file `Vagrantfile` with `Vagrantfile.template`
+````bash
+cp Vagrantfile.template Vagrantfile
+````
+In `Vagrantfile` Update `VM_HOST_PATH` with your local file path of your machine. 
+````
+#VM_HOST_PATH# => your local machine path of the project
+````
+run `pwd` and copy the path in this variable.
+To start your VM Vagrant, run
+````bash
+Vagrant up
+````
+To connect on your VM run 
+````bash
+Vagrant ssh
+````
+To start project environment docker, run
+````bash
+docker-compose up
+````
+You environment run in you VM Vagrant. When you want stop your VM, you can run
+````bash
+Vagrant halt
+````
+If you want to destroy, you can run
+````bash
+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.
+
+
index 97290635d8bff0b074129e2cd172d872e31abab0..b86e21c86a7f36d3245fbcf560ecf0e9c7eaf544 100644 (file)
@@ -14,7 +14,7 @@
     "url": "git+https://github.com/thecodingmachine/workadventure.git"
   },
   "author": "g.parant@thecodingmachine.com",
-  "license": "ISC",
+  "license": "AGPL",
   "bugs": {
     "url": "https://github.com/thecodingmachine/workadventure/issues"
   },
index 7aca504e26b5eeebc6ebf4ac83f7b7b6305a7f8a..869235638ed7451d0b81a28a325993c14aebb4f2 100644 (file)
@@ -32,5 +32,5 @@ services:
     volumes:
       - ./back:/usr/src/app
     labels:
-      - "traefik.http.routers.back.rule=Host(`back.workadventure.localhost`)"
+      - "traefik.http.routers.back.rule=Host(`api.workadventure.localhost`)"
       - "traefik.http.services.back.loadbalancer.server.port=8080"