System Manual

System Manuel

Frontend

System Requirements

• You need to 4GB free space to install the docker

Frontend Installation Instructions

1. You need to first install docker.
   • The easiest way to install docker is through Docker Desktop.
   • Based on your operating system you can follow the steps that are described here.
   • For example, for Ubuntu you can download docker instructions using: $ sudo apt-get update $ sudo apt-get install ./docker-desktop-<version>-<arch>.deb
2. You need to clone our repository by: git clone [email protected]:bounswe/bounswe2023group5.git
3. Go to frontend directory by: cd app/frontend
4. You can run it without docker by (for this you need to have pnpm): pnpm install pnpm run dev
5. Or you can run it using docker by: docker build -t game-app . docker run game-app

Backend

System Requirements

• You need to 4GB free space to install the docker

Backend Installation Instructions

1. You need to first install docker.
   • The easiest way to install docker is through Docker Desktop.
   • Based on your operating system you can follow the steps that are described here.
   • For example, for Ubuntu you can download docker instructions using: $ sudo apt-get update $ sudo apt-get install ./docker-desktop-<version>-<arch>.deb
2. You need to clone our repository by: git clone [email protected]:bounswe/bounswe2023group5.git
3. Go to backend directory by: cd app/backend or cd app/annotation
4. You can run it without docker by (for this you need to have maven): sudo apt install maven mvn spring-boot:run
5. Or you can run it using docker by: docker build -t bounswe2023group5:latest . docker run -p 8080:8080 bounswe2023group5:latest
6. Then you can check the local swagger page to see if it is working. http://localhost:8080/swagger-ui/index.html

Mobile

System Requirements

• You need at least 5GB free space to install Unity

Mobile Installation Instructions

1. You need to install Unity. You can see the installation steps here.
2. You need to clone our repository by: git clone [email protected]:bounswe/bounswe2023group5.git
3. Open the mobile project with Unity from path app/mobile
4. You need to install Android Build Support. You can install it from File > Build settings > Select Platform: Android > Install with Unity Hub.
5. Build the .apk file of the app by File > Build settings > Select Platform: Android > Build.
6. Transfer the .apk file to your Android device.
7. Then you can use the application by executing the .apk file.