Pre-requisites

• Git

Docker Pre-requisites

• Windows 10 Home
  • Install wsl2 and Ubuntu
• Install Docker Desktop from Docker Hub
• Linux
  • Use docker group instead of sudo

Getting Started with Docker

1. Build docker image

   bin/build-env.sh

2. Run docker image

   #Usage bin/run-env.sh <port - optional(default 8081)>
   bin/run-env.sh

3. Build project web server (inside docker image) NOTE: You won't be able to cd here yet because the DeliverySystem directory does not exist. If you were able to launch the above commands you should now be inside the docker image. You can exit it with CTRL+D now.

   # Inside docker image
   cd /home/user/repo/DeliverySystem
   make

4. Run web server (inside docker image)

   # MUST be within DeliverySystem/ directory inside docker image
   cd /home/user/repo/DeliverySystem
   ./bin/run.sh

5. Open up Firefox and browse to http://127.0.0.1:8081/

Getting Started using SSH on CSE Lab machines

1. Run the ssh environment

   # Run the ssh environment
   # Example: ./bin/ssh-env.sh <x500> <port> <computer num>
   ./bin/ssh-env.sh myx500 8081 05

2. Build and run the simulation

   cd /path/to/DeliverySystem
   make -j
   ./bin/run.sh

3. Open up Firefox and browse to http://127.0.0.1:8081/

Getting Started with VOLE-3D or VOLE

1. Log on to VOLE-3D or VOLE (VOLE is slower for graphics, but is great for tests, etc...)

2. Build project

   cd /path/to/cloned/repository
   cd DeliverySystem
   make

3. Run DeliverySystem

   # MUST be within project/ directory
   ./bin/run.sh

4. Open up Firefox and browse to http://127.0.0.1:8081/