From d91173661f25fd75678b1746147dc2857b2c3a94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Utku=20=C3=87elik?= Date: Tue, 22 Oct 2024 00:08:40 +0300 Subject: [PATCH] Write build and deploy instructions --- instructions.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 instructions.md diff --git a/instructions.md b/instructions.md new file mode 100644 index 00000000..9b33c5be --- /dev/null +++ b/instructions.md @@ -0,0 +1,39 @@ +## Build and Deploy Instructions + +### Local Deployment + +1. Install Git, Docker, and Docker Compose if they are not already installed. + +2. Clone the repository: + ``` + git clone https://github.com/bounswe/bounswe2024group5.git + cd bounswe2024group5 + ``` + +3. Build and start the Docker containers: + ``` + docker-compose up --build + ``` + +4. Access the application by opening a web browser and navigating to `http://localhost/` + +### Cloud Deployment + +1. Create a virtual machine on a cloud provider. Ensure it has a public IP address and that HTTP port 80 is open. + +2. Connect to the virtual machine via SSH. Install Git, Docker, and Docker Compose if they are not already installed. + +3. Clone the repository to the virtual machine: + ``` + git clone https://github.com/bounswe/bounswe2024group5.git + cd bounswe2024group5 + ``` + +4. Change the IP address in `frontend/src/App.tsx` to the public IP address of your virtual machine. + +5. Build and start the Docker containers: + ``` + docker-compose up --build + ``` + +6. Access the application by opening a web browser and navigating to `http:///`