Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 5.95 KB

README.md

File metadata and controls

95 lines (60 loc) · 5.95 KB
Raw

IMUV - Flying Campus

IMUV-Homepage Online demo: https://www.imuvirtuel.fr/.

IMUV is a game application built on the UD-Viz framework.

A web application

Composed of a backend and a frontend. Its backend node application provides an HTTP server and a websocket communication layer (expecting Imuv client connections), code can be found in ./bin/backend/ and in ./src/shared. Frontend code can be found in ./src/browser and also ./src/shared.

REPOSITORIES GITHUB

Repository Link Description
UD-Viz https://github.com/VCityTeam/UD-Viz Javascript framework for urban data visualization.
UD-Imuv-Docker https://github.com/VCityTeam/UD-Imuv-docker Docker image for the IMUV server.
UD-Demo-IMU-Imuv https://github.com/VCityTeam/UD-Demo-IMU-Imuv Docker-compose file to run IMUV and services it depends on for some features. (Authentification, Editor, Whiteboard, chat audio/video/text ...)

Pre-requisites to install IMUV

Install node/npm

For the npm installation refer here

UD-Imuv has been reported to work with versions:

  • node version 18
  • npm version: 9

Install ImageMagick and GraphicsMagick

For the install imagemagick and graphicsmagick binary sub dependencies since the server needs gm.

  • Linux
 sudo apt-get install -y imagemagick graphicsmagick
  • Windows
    • It seems not necessary to install imagemagick on Windows.
    • Download and install graphicsmagick from graphicmagick-binaries (IMUV has been reported to work with version 1.3.34-Q8)

⚠️ TIP : allias gm doesn't work in powershell because it conflicts with the command Get-Member !!!!

If at runtime the Imuv backend displayed image errors then you should check the installation of those binary dependencies.

Install Parse-Server and MongoDB (optionnal)

For certain features (authentification, editor, menu avatar...), Imuv requires a parse-server. It stores the user accounts and the user's data.

Self-hosting :

  • You can clone the repo of the docker-compose UD-Demo-IMU-Imuv and follow the instructions to install the parse-server and the MongoDB database: Set up environment variables in UD-Demo-IMU-Imuv : cp env-default .env and edit the .env file. (Put default proposed values in PARSE_SERVER_URL and MONGO_HOST).
    • Run docker-compose up -d parse-server mongodb to start the parse-server and the MongoDB database.

OR

  • You can find docker image and read doc here.

Set the environment variables

You can set the environment variables in a .env file:

  • cp env-default .env
  • edit the .env file. (Make sure to set the correct value for the PARSE_APP_ID and PARSE_MASTER_KEY variables)
VARIABLES DESCRIPTION
PARSE_SERVER_URL URL of your parse-server (ex: http://localhost:1337/parse ; cf https://github.com/VCityTeam/UD-Imuv#install-parse-server-and-mongodb-optionnal)
PARSE_APP_ID Application ID of your parse-server. This will be used by imuv server to authenticate with the parse-server.
PARSE_MASTER_KEY Master key of your parse-server. This will be used by imuv server to authenticate with the parse-server.
JITSI_PUBLIC_URL URL of the jitsi server. You can use the dev serv https://meet.jit.si or install your own jitsi server with docker-compose
WBO_PUBLIC_URL URL of the whitebophir server. You can use the dev serv https://wbo.ophir.dev or install your own whitebophir server with docker-compose
PORT Server port number
JSON_WEB_TOKEN_SECRET Token for authentication features (sign in / sign up). cf https://fr.wikipedia.org/wiki/JSON_Web_Token

Start Imuv applications

Imuv can be locally (on your desktop) started in the following way:

npm install
npm run start

and then use your favorite (web) browser to open http://localhost:8000/ (8000 or PORT which is specified in .env).

Developers

Go to docs/Devel/Developers.md.