SAE S5.A.01 - Cryptoportique 3D Arles

📋 Table of Contents

📕 Description

📋 Table of Contents

🔨 Installation

🟢​ Usage

🆘​ Support

✍️ Authors

📕 Description

This project is a web application that allows users to visualize the Cryptoportique of the City of Arles in 3D. You can either access it through a phone, tablet, computer, or even a virtual reality headset !

🔨 Installation

local execution

Prerequisites

execute the install-dependencies.sh script as administrator to install the necessary dependencies.

./install-dependencies.sh

On some systems, you may need to set the execution permission to the script:

chmod +x install-dependencies.sh

Required modules and packages

execute the install.sh script to install the necessary modules and packages.

./install.sh

On some systems, you may need to set the execution permission to the script:

chmod +x install.sh

Docker execution

With the provided script

1. download the latest image
2. download the script start.sh
3. on docker, create a volume with 3Ds data in it and name it cryptoserver_objects
4. run the script with docker started on your machine, with the path to your image as argument. Provide informations when they are required. (./start.sh path/to/your/image)
5. You can access your application using the port gived in the logs of the server (default 5000)

Manually

1. download the latest image (two version are available, debug and release)
2. create a volume with 3Ds data in it
3. run the image with the volume mounted on /app/client/objects and the port 5000 exposed

   if you named your volume cryptoserver_objects, you can run the following command:
   shell docker run -it -p 5000:5000 -v cryptoserver_objects:/app/client/objects --name cryptoserver cryptoserver:relase

🟢 Usage

to build the docker image

make image

or

make image-debug

to build the app without docker

make

to start the server (using docker) (recommended)

make start

or

make start-debug

to start the server (without docker)

make start-local

to run the tests:

make test

🆘 Support

If you have any questions, please open an issue on the repository.

✍️ Authors

• Antoine Buirey
• Evan Massol
• Alassane Seck
• Robyn Tambon