Merge pull request #18 from gparant/create-backend

Create backend
This commit is contained in:
David Négrier 2020-04-04 13:19:40 +02:00 committed by GitHub
commit cb11acc428
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 2448 additions and 0 deletions

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
.idea
.vagrant
Vagrantfile

View File

@ -30,3 +30,67 @@ Note: on some OSes, you will need to add this line to your `/etc/hosts` file:
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](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 a config file `Vagrantfile` from `Vagrantfile.template`
```bash
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:
```bash
Vagrant up
```
To connect to your VM, run:
```bash
Vagrant ssh
```
To start project environment, run
```bash
docker-compose up
```
You environment runs 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.

80
Vagrantfile.template Normal file
View File

@ -0,0 +1,80 @@
# encoding: utf-8
# -*- mode: ruby -*-
# vi: set ft=ruby :
# Box / OS
VAGRANT_BOX = 'bento/ubuntu-19.10'
# VM User — 'vagrant' by default
VM_USER = 'vagrant'
VM_NAME = 'workadventure'
VM_GUEST_PATH = '/opt/workadventure'
VM_HOST_PATH = '#VM_HOST_PATH#'
# # VM Port — uncomment this to use NAT instead of DHCP
# VM_PORT = 8080
Vagrant.configure(2) do |config|
# Vagrant box from Hashicorp
config.vm.box = VAGRANT_BOX
# Actual machine name
config.vm.hostname = VM_NAME
# Set VM name in Virtualbox
config.vm.provider "virtualbox" do |v|
v.name = VM_NAME
v.memory = 8192
v.cpus = 4
end
#DHCP — comment this out if planning on using NAT instead
#config.vm.network "private_network", type: "dhcp"
config.vm.network :forwarded_port, guest: 80, host: 80
config.vm.network :forwarded_port, guest: 8080, host: 8080
# Sync folder
config.vm.synced_folder VM_HOST_PATH, VM_GUEST_PATH
#,type: "smb"
#if you push directly credential to access at your sharing file, you can use :
#,smb_password: "#MAC_PASSWORD#"
#,smb_username: "#MAC_USER#"
#,mount_options: [ "username=#MAC_USER#", "password=#MAC_PASSWORD#" ]
# Disable default Vagrant folder, use a unique path per project
config.vm.synced_folder '.', '/home/'+VM_USER+'', disabled: true
# Use config of you local machine for root user
#config.vm.provision "file", source: "~/.ssh/id_rsa", destination: '/home/'+VM_USER+'/.ssh/id_rsa'
#config.vm.provision "file", source: "~/.ssh/id_rsa.pub", destination: '/home/'+VM_USER+'/.ssh/id_rsa.pub'
#config.vm.provision "file", source: "~/.ssh/known_hosts", destination: '/home/'+VM_USER+'/.ssh/known_hosts'
#config.vm.provision "file", source: "~/.bash_profile", destination: '/home/'+VM_USER+'/.bash_profile'
#config.vm.provision "file", source: "~/.gitconfig", destination: '/home/'+VM_USER+'/.gitconfig'
#Install package for your VM
config.vm.provision "shell",
env: {"VM_GUEST_PATH" => VM_GUEST_PATH},
inline: <<-SHELL
echo
apt-get update -y
apt-get install -y git
apt-get install -y apt-transport-https
apt-get install -y build-essential
apt-get install -y curl
apt-get install -y gnupg-agent
apt-get install -y software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
apt-key fingerprint 0EBFCD88
add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"
apt-get update -y
apt-get install -y docker-ce docker-ce-cli containerd.io
curl -L "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
usermod -aG docker vagrant
newgrp docker
echo "cd ${VM_GUEST_PATH}" >> /home/vagrant/.bashrc
SHELL
end

27
back/.eslintrc.json Normal file
View File

@ -0,0 +1,27 @@
{
"root": true,
"env": {
"browser": true,
"es6": true,
"node": true
},
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended"
],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"plugins": [
"@typescript-eslint"
],
"rules": {
"no-unused-vars": "off"
}
}

4
back/.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
/dist/
/node_modules/
/dist/bundle.js
/yarn-error.log

36
back/package.json Normal file
View File

@ -0,0 +1,36 @@
{
"name": "workadventureback",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"tsc": "tsc",
"dev": "ts-node-dev --respawn --transpileOnly ./server.ts",
"prod": "tsc && node ./dist/server.js",
"lint": "node_modules/.bin/eslint src/ . --ext .ts"
},
"repository": {
"type": "git",
"url": "git+https://github.com/thecodingmachine/workadventure.git"
},
"author": "g.parant@thecodingmachine.com",
"license": "AGPL",
"bugs": {
"url": "https://github.com/thecodingmachine/workadventure/issues"
},
"homepage": "https://github.com/thecodingmachine/workadventure#readme",
"dependencies": {
"@types/express": "^4.17.4",
"@types/socket.io": "^2.1.4",
"body-parser": "^1.19.0",
"express": "^4.17.1",
"socket.io": "^2.3.0",
"ts-node-dev": "^1.0.0-pre.44",
"typescript": "^3.8.3"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^2.26.0",
"@typescript-eslint/parser": "^2.26.0",
"eslint": "^6.8.0"
}
}

3
back/server.ts Normal file
View File

@ -0,0 +1,3 @@
// lib/server.ts
import App from "./src/App";
App.listen(8080, () => console.log(`Example app listening on port 8080!`))

26
back/src/App.ts Normal file
View File

@ -0,0 +1,26 @@
// lib/app.ts
import {IoSocketController} from "./Controller/IoSocketController";
import express from "express";
import {Application} from 'express';
import bodyParser = require('body-parser');
import * as http from "http";
class App {
public app: Application;
public server: http.Server;
public ioSocketController: IoSocketController;
constructor() {
this.app = express();
this.config();
this.server = http.createServer(this.app);
this.ioSocketController = new IoSocketController(this.server);
}
private config(): void {
this.app.use(bodyParser.json());
this.app.use(bodyParser.urlencoded({extended: false}));
}
}
export default new App().server;

View File

@ -0,0 +1,36 @@
import socketIO = require('socket.io');
import {Socket} from "socket.io";
import * as http from "http";
import {MessageUserPosition} from "@Model/Websocket/MessageUserPosition";
export class IoSocketController{
Io: socketIO.Server;
constructor(server : http.Server) {
this.Io = socketIO(server);
this.ioConnection();
}
ioConnection() {
this.Io.on('connection', (socket: Socket) => {
//TODO check token access
/*join-rom event permit to join one room.
message :
userId : user identification
roomId: room identification
positionXUser: user x position map
positionYUser: user y position on map
*/
socket.on('join-room', (message : MessageUserPosition) => {
socket.join(message.roomId);
// sending to all clients in room except sender
socket.to(message.roomId).emit('join-room', message.toString());
});
socket.on('user-position', (message : MessageUserPosition) => {
// sending to all clients in room except sender
socket.to(message.roomId).emit('join-room', message.toString());
});
});
}
}

View File

@ -0,0 +1,17 @@
export class Message {
userId: string;
roomId: string;
constructor(message: string) {
let data = JSON.parse(message);
this.userId = data.userId;
this.roomId = data.roomId;
}
toJson() {
return {
userId: this.userId,
roomId: this.roomId,
}
}
}

View File

@ -0,0 +1,24 @@
import {Message} from "./Message";
export class MessageUserPosition extends Message{
positionXUser: string;
positionYUser: string;
constructor(message: string) {
super(message);
let data = JSON.parse(message);
this.positionXUser = data.positionXUser;
this.positionYUser = data.positionYUser;
}
toString() {
return JSON.stringify(
Object.assign(
super.toJson(),
{
positionXUser: this.positionXUser,
positionYUser: this.positionYUser
})
);
}
}

70
back/tsconfig.json Normal file
View File

@ -0,0 +1,70 @@
{
"compilerOptions": {
"experimentalDecorators": true,
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
"baseUrl": ".", /* Base directory to resolve non-absolute module names. */
"paths": {
"@Controller/*": ["src/Controller/*"],
"@Model/*": ["src/Model/*"]
}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
/* Advanced Options */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}

2047
back/yarn.lock Normal file

File diff suppressed because it is too large Load Diff

View File

@ -23,3 +23,14 @@ services:
labels:
- "traefik.http.routers.front.rule=Host(`workadventure.localhost`)"
- "traefik.http.services.front.loadbalancer.server.port=8080"
back:
image: thecodingmachine/nodejs:12
command: yarn dev
environment:
STARTUP_COMMAND_1: yarn install
volumes:
- ./back:/usr/src/app
labels:
- "traefik.http.routers.back.rule=Host(`api.workadventure.localhost`)"
- "traefik.http.services.back.loadbalancer.server.port=8080"