From ac5f9ac0aa30f04bd4021e87aec96274ed29e308 Mon Sep 17 00:00:00 2001 From: Sakan Date: Sun, 29 Sep 2024 17:57:07 +0700 Subject: [PATCH 1/5] chore: updated gitignore --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.gitignore b/.gitignore index 6bbf600..e48de4b 100644 --- a/.gitignore +++ b/.gitignore @@ -167,3 +167,8 @@ cython_debug/ /backend/scraped_hotel_data/ /backend/.idea/ /prototypes/ + +**/*.idea +/frontend/node_modules +/frontend/npm +/build_exe.sh \ No newline at end of file From 9fb51fe9e575ad8e4649f88014aefbf2f68c8e7b Mon Sep 17 00:00:00 2001 From: Sakan Date: Sun, 29 Sep 2024 17:57:17 +0700 Subject: [PATCH 2/5] docs: updated README.md --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 75f4438..62c2827 100644 --- a/README.md +++ b/README.md @@ -18,40 +18,40 @@ A **lower Price/Review Score** indicates that the place is **not expensive**, ye ## How to Use the Web App ### Step 1: Set Up the Web App - 1. **Install Docker Desktop** - [Click here](https://www.docker.com/products/docker-desktop) to download Docker Desktop. - Follow the instructions on the website to install it on your computer. +2. Download Web App Assets + - Click here to [Click here](https://www.docker.com/products/docker-desktop) to download the web-app assets. + - Extract the ZIP file. -2. **Download the Configuration File** - - [Click here](docker-compose.yml) to download the docker-compose.yml file. - - Save it in a folder where you can easily find it (e.g., your Desktop or Documents). - -3. **Find Your User Agent** +### Step 2: Find Your User Agent +1. **Find Your User Agent** - Open your web browser and go to [What Is My Browser](https://www.whatismybrowser.com/detect/what-is-my-user-agent/). - You will see a message that shows your User Agent. **Copy this text.** -4. **Edit the Configuration File** - - Open the `docker-compose.yml` file you downloaded in a text editor (like Notepad). +2. **Edit the Configuration File** + - Open the `docker-compose.yml` file you extracted from the ZIP file in a text editor (like Notepad). - Look for the line that says `USER_AGENT`. Replace `your_user_agent` text with the User Agent you copied. - Save the file and close the text editor. -5. **Start the Web App** +### Step 3: Access the Web App +1. **Start the Web App** - Make sure that the Docker Desktop is running. - If not, start the Docker Desktop. - - Open a **Command Prompt**, **Terminal**, or **Console** window on your computer: - - **Windows:** Search for "Command Prompt" or "cmd" in the Start menu. - - **macOS:** Open "Terminal" from the Applications > Utilities folder, or search for it using Spotlight (Cmd + Space). - - **Linux:** Open "Terminal" from your applications menu or use the shortcut Ctrl + Alt + T. - - Navigate to the folder where you saved the `docker-compose.yml` file. You can do this by typing `cd path_to_your_folder`, where `path_to_your_folder` is the location of your file. - - Type the following command and press **Enter**: - ``` - docker-compose up - ``` - -### Step 2: Access the Web App -- Open your web browser and go to: [http://localhost:5000/](http://localhost:5000/) -- To stop the web app, return to the Command Prompt or Terminal window and press **Ctrl + C**. + - Double-click the executable file: + - **Windows:** Double-click `app-windows.exe` + - **macOS:** Double-click `app-mac.exe` + - **Linux:** Double-click `app-linux.exe` +2. **Check the Terminal**: + - A terminal window will open, indicating that the web app is starting. + You should see messages in the terminal that confirm the app is launching. + +3. **Access the Web App** + - Open your web browser and go to: [http://localhost:5000/](http://localhost:5000/) + +### Step 4: Exit the Web App +- Press `Enter` as prompted in the terminal. - Alternatively, you can open Docker Desktop and stop the container from the **Containers** section. ## Disclaimer From d3a96e63743ce8b5d12e0ba668ec9a1f89545527 Mon Sep 17 00:00:00 2001 From: Sakan Date: Sun, 29 Sep 2024 18:07:56 +0700 Subject: [PATCH 3/5] docs: updated README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 62c2827..75c2469 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ A **lower Price/Review Score** indicates that the place is **not expensive**, ye - If not, start the Docker Desktop. - Double-click the executable file: - **Windows:** Double-click `app-windows.exe` - - **macOS:** Double-click `app-mac.exe` - - **Linux:** Double-click `app-linux.exe` + - **macOS:** Double-click `app-mac` + - **Linux:** Double-click `app-linux` 2. **Check the Terminal**: - A terminal window will open, indicating that the web app is starting. You should see messages in the terminal that confirm the app is launching. From 8db76fab59c30afeccf563b81d88779260a63f4d Mon Sep 17 00:00:00 2001 From: Sakan Date: Sun, 29 Sep 2024 18:08:13 +0700 Subject: [PATCH 4/5] ci: added test EXE workflow --- .github/workflows/exe-test.yml | 38 ++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/exe-test.yml diff --git a/.github/workflows/exe-test.yml b/.github/workflows/exe-test.yml new file mode 100644 index 0000000..5c1ebdf --- /dev/null +++ b/.github/workflows/exe-test.yml @@ -0,0 +1,38 @@ +name: Test EXE File + +on: + push: + branches: + - main + pull_request: + +jobs: + test-windows: + runs-on: windows-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Run EXE file tests on Windows + run: | + .\app-windows.exe --test + + test-macos: + runs-on: macos-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Run EXE file tests on macOS + run: | + ./app-mac --test + + test-linux: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Run EXE file tests on Linux + run: | + ./app-linux --test From 030a495ee10c28191ec9ff58c82016f51cc40424 Mon Sep 17 00:00:00 2001 From: Sakan Date: Sun, 29 Sep 2024 18:10:50 +0700 Subject: [PATCH 5/5] ci: added test EXE workflow --- .github/workflows/exe-test.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/exe-test.yml b/.github/workflows/exe-test.yml index 5c1ebdf..82b9e4f 100644 --- a/.github/workflows/exe-test.yml +++ b/.github/workflows/exe-test.yml @@ -5,6 +5,8 @@ on: branches: - main pull_request: + branches: + - main jobs: test-windows: @@ -25,7 +27,7 @@ jobs: - name: Run EXE file tests on macOS run: | - ./app-mac --test + chmod +x ./app-mac --test test-linux: runs-on: ubuntu-latest @@ -35,4 +37,4 @@ jobs: - name: Run EXE file tests on Linux run: | - ./app-linux --test + chmod +x ./app-linux --test