Merge pull request #373 from bounswe/development

Merging to Main for Pre-release

.github/workflows/backend-deploy.yml

@@ -23,11 +23,11 @@ jobs:
           SSH_PRIVATE_KEY: ${{ secrets.BACKEND_EC2_SSH_KEY }}
           REMOTE_HOST: 3.125.225.39
           REMOTE_USER: ubuntu
-          SOURCE: ./ludos/backend
+          SOURCE: ludos/backend/
           TARGET: ~/backend
           ARGS: --delete
           EXCLUDE: .env
           SCRIPT_AFTER: |
             cd ~/backend
             docker compose -f docker-compose.test.yml up -d --build
-            docker image prune -af && docker builder prune -f && docker builder prune -af --filter until=10m && docker volume prune -af
+            docker image prune -af && docker builder prune -f && docker builder prune -af --filter until=10m && docker volume prune -af

.github/workflows/frontend-deploy.yml

@@ -17,17 +17,29 @@ jobs:
       - name: Checkout the files
         uses: actions/checkout@v2
 
+      - name: Build the Docker image
+        run: docker build ludos/frontend -t frontend --target=prod --build-arg REACT_APP_API_URL=3.125.225.39:8080
+
+      - name: Save Docker image
+        run: docker save frontend | gzip > frontend.tar.gz
+
       - name: Deploy to server
         uses: easingthemes/ssh-deploy@main
         env:
           SSH_PRIVATE_KEY: ${{ secrets.FRONTEND_EC2_SSH_KEY }}
           REMOTE_HOST: 51.20.170.143
           REMOTE_USER: ubuntu
-          SOURCE: ludos/frontend/
+          SOURCE: frontend.tar.gz
           TARGET: ~/frontend
           ARGS: --delete
           EXCLUDE: .env
+          SCRIPT_BEFORE: |
+            sudo rm -rf frontend || true
+            mkdir frontend
+            sudo docker container stop frontend || true
+            sudo docker container rm frontend || true
           SCRIPT_AFTER: |
             cd ~/frontend
-            docker compose up -d --build
-            docker image prune -af && docker builder prune -f && docker builder prune -af --filter until=10m && docker volume prune -af
+            sudo docker load -i frontend.tar.gz
+            sudo docker run -p 3000:3000 --name frontend -d frontend 
+            docker image prune -af && docker builder prune -f && docker builder prune -af --filter until=10m && docker volume prune -af

.gitignore

@@ -0,0 +1,3 @@
+# Ignore the Intellij related folders
+.idea
+node_modules

README.md

@@ -1,5 +1,5 @@
 <h1 align="center"> :video_game: The Game Forum Project - bounswe2023 Group 7</h1>
-We are the junior and senior students of Boğaziçi University Computer Engineering Department. For "Fundamentals of Software Engineering" course in our university, we have come together and started to develop a game forum. At this stage we are working on project pre-planning.
+We are the junior and senior students of Boğaziçi University Computer Engineering Department. For the "Fundamentals of Software Engineering" course at our university, we have come together and started to develop a game forum. At this stage, we are working on project pre-planning.
 
 <br>To learn more about us, you can visit our [***wiki***](https://github.com/bounswe/bounswe2023group7/wiki) page.
 <details open><summary><h2>Contents</h2></summary>
@@ -12,7 +12,7 @@ We are the junior and senior students of Boğaziçi University Computer Engineer
 </details>
 <details open><summary><h2> :clipboard: Description </h2></summary>
 
-This project is basically a gaming community platform where different users, including developers, gamers, and e-sports players, can socialize and collaborate. We aim to create an environment in which users can discuss with each other, read reviews, organise events such as e-sports tournament, join the game communities and benefit from many more opportunities like these. Except video games, the platform can be extended for board games too. As an example, the platform can have functionalities similar to group finders in MMORPGs to match people. 
+This project is basically a gaming community platform where different users, including developers, gamers, and e-sports players, can socialize and collaborate. We aim to create an environment in which users can discuss with each other, read reviews, join the game communities, and benefit from many more opportunities like these. Except for video games, the platform can be extended for board games too. As an example, the platform can have functionalities similar to group finders in MMORPGs to match people. 
 </details><details open><summary><h2> :busts_in_silhouette: Contributors </h2></summary>
 
 - [*Elif Kızılkaya*](https://github.com/elifkizilky)

ludos/.gitignore

@@ -0,0 +1,2 @@
+# Ignore the Intellij related folders
+.idea

ludos/README.md

@@ -0,0 +1,62 @@
+<p align="center">
+ <img width="200" src="https://github.com/bounswe/bounswe2023group7/assets/47900788/abacbafe-f971-4233-be77-fe5167156730" alt="Material Bread logo">
+</p>
+<h1 align="center">
+Welcome to Ludos!
+</h1>
+
+Ludos stands as a dynamic gaming community platform, serving as the hub for developers, gamers, and e-sports enthusiasts to foster social connections and collaborate on game-related matters. Our versatile application seamlessly attends to both video games and board games, providing a comprehensive space for diverse gaming interests. Additionally, our platform features robust group functionality, enabling like-minded individuals to connect and engage in shared gaming experiences. 
+
+Elevate your gaming journey with Ludos – where community, collaboration, and fellowship converge.
+
+## How to run frontend?
+
+### Prerequisites
+
+Before you begin, ensure you have the following installed:
+
+- [Docker](https://www.docker.com/get-started)
+
+### Steps to Deploy
+
+1. **Clone the Repository:**
+    ```bash
+     git clone https://github.com/bounswe/bounswe2023group7.git
+     ```
+2. **Go to Directory:**
+   ```bash
+   cd ludos/frontend
+   ```
+3. **Ensure that you have docker installed and running.**
+4. **Build the Docker Image and Run:**
+    ```bash
+    docker compose up --build
+    ```
+
+5. **Access Our Project**
+ Now, it is available at *localhost:3000/*
+
+
+### Deployed Version of frontend
+Go to our website link which is http://51.20.170.143:3000/. User can [register](http://51.20.170.143:3000/signup) to the platform and then [login](http://51.20.170.143:3000/login). In addition to that, for milestone 1, we provided mock pages for:
+* Forum page about *Video Games*: [/forum](http://51.20.170.143:3000/forum)
+*    Game Pages for:
+
+      * *Red Dead Redemption 2* : [/game/Red-Dead-Redemption-2](http://51.20.170.143:3000/game/Red-Dead-Redemption-2)
+      * *Witcher 3* : [/game/Witcher-3](http://51.20.170.143:3000/game/Witcher-3)
+      * *God of War 2018*: [/game/God-of-War-2018](http://51.20.170.143:3000/game/God-of-War-2018)
+* For home page, the link is [/](http://51.20.170.143:3000/)
+
+## How to run mobile app?
+- You can download APK version of the app from [here](https://drive.google.com/file/d/1Ieu20D_CrqKhxDXEw02KYTmpz7JwTCRt/view?usp=drive_link ) and directly run it in your Android device.
+- If you want to use an emulator to open the application:
+  - You can download an Android emulator with Android Studio through [this link](https://developer.android.com/studio?hl=tr).
+  - Then you can easily run the application on Android Studio following [this guide](https://www.geeksforgeeks.org/how-to-import-existing-flutter-project-in-android-studio/).
+
+## How to run backend application?
+Deployed Swagger Documentation: http://3.125.225.39:8080/api 
+
+```WORKDIR=./ludos/backend```<br/>
+1. Create a .env file for the environment variables. Please ask for the variables. The name of the variables are included in .env.example file. <br/>
+2. Run ```docker compose up --build``` <br/>
+3. Now, the api is available with localhost:8080 base url.

ludos/backend/.env.example

@@ -3,4 +3,9 @@ DB_HOST=
 DB_USER=
 DB_PASSWORD=
 DB_PORT=
-DB_NAME=
+DB_NAME=
+JWT_SECRET=
+JWT_EXPIRES_IN=
+MAIL_SMTP=
+MAIL_USER=
+MAIL_PASS=

ludos/backend/README.md

@@ -1 +1,7 @@
-Backend of LUDOS project
+# LUDOS Backend Api
+Deployed Swagger Documentation: http://3.125.225.39:8080/api 
+## How to run?
+```WORKDIR=./ludos/backend```<br/>
+1. Create a .env file for the environment variables. Please ask for the variables. The name of the variables are included in .env.example file. <br/>
+2. Run ```docker compose up --build``` <br/>
+3. Now, the api is available with localhost:8080 base url.