0.9.0

Group 8 Cmpe451 2023 Fall Final

Build and Deployment Instructions

Pre-requisites

• Docker
• Docker-Compose
• Git

Pre-build

1. Clone the Repository

   git clone https://github.com/bounswe/bounswe2023group8.git
   

2. Database Environment Configuration (Required)
   Navigate to the root directory:

   cd bounswe2023group8/app
   

   Create a .env.annotation-db file and populate it with the values provided in the annotation-db file, which is located in the 'secrets' folder of the deliverables uploaded to Moodle.

3. Database Environment Configuration (Required)
   Navigate to the root directory:

   cd bounswe2023group8/app
   

   Create a .env.enigma-db file and populate it with the values provided in the enigma-db file, which is located in the 'secrets' folder of the deliverables uploaded to Moodle.

4. Backend Environment Configuration (Required)
   Navigate to enigma directory:

   cd bounswe2023group8/app/backend/enigma
   

   Create a .env file and populate it with the values provided in the enigma-server file, which is located in the 'secrets' folder of the deliverables uploaded to Moodle.

5. Backend Environment Configuration (Required)
   Navigate to the annotation directory:

   cd bounswe2023group8/app/backend/annotation
   

   Create a .env file and populate it with the values provided in the annotation-server file, which is located in the 'secrets' folder of the deliverables uploaded to Moodle.

6. Frontend Environment Configuration (Required)
   Navigate to the web directory and modify the .env.development file:

   cd bounswe2023group8/app/web
   

   Replace IP of the REACT_APP_BACKEND_API_URLwith the IP of the host machine. (localhost if in local environment)

Build steps

1. Navigate to App Directory

   cd bounswe2023group8/app
   

2. Start Services with Docker-Compose

   docker-compose up
   

If you encounter any issues in determining the correct values, please contact @bakikucukcakiroglu to obtain a valid .env file.

After running the above steps, your application should be up and running. You can send requests to 80 port of the host machine. Make sure to check any logs for potential issues during startup.

Please refer to Final Project Report for Changelog.