Beta release

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: Bug Report
+about: Help us identify and fix issues by reporting a bug
+title: "[Bug] Brief description of the issue"
+labels: bug
+assignees: ''
+---
+
+## Description
+Provide a detailed and clear description of the bug. What is happening, and what is the expected behavior?
+
+## Steps to Reproduce
+Outline the steps to replicate the issue:
+1. Go to '...'
+2. Perform '...'
+3. Observe '...'
+
+## Expected Behavior
+What should have happened if the bug were not present?
+
+## Actual Behavior
+What actually happened instead?
+
+## Environment Details
+Include specific details about the environment where the bug occurred:
+- **Operating System**: (e.g., Windows 10, macOS Ventura, Ubuntu 22.04)
+- **Browser**: (e.g., Chrome 112, Firefox 99)
+- **Device**: (e.g., Desktop, Mobile, Tablet)
+- **Version/Build**: (e.g., App version 1.2.3, Commit Hash)
+
+## Screenshots or Logs
+If applicable, attach screenshots, error logs, or any other relevant information to help us better understand the issue.
+
+## Additional Context
+Provide any other context about the problem here. For example:
+- Is this bug intermittent or consistent?
+- Was any workaround attempted?
+
+## Severity Level
+Please indicate how severe this bug is:
+- [ ] Blocker: Prevents usage entirely
+- [ ] Critical: Major issue affecting key functionality
+- [ ] Minor: Affects non-essential features
+- [ ] Enhancement: Improvement opportunity, not a defect

.github/ISSUE_TEMPLATE/custom_template.md

@@ -0,0 +1,22 @@
+---
+name: Custom Issue
+about: Use this template for any issues not covered by bugs or feature requests
+title: "[Custom Issue]: Brief title summarizing the issue"
+labels: ''
+assignees: ''
+---
+
+## Overview
+Provide a clear and concise summary of the issue or topic you want to address.
+
+## Purpose
+Explain why this issue is important. What is the goal or outcome you hope to achieve by addressing it?
+
+## Details
+Share any relevant information, background, or context. If applicable, include references, links, or examples that help explain the issue.
+
+## Suggested Action
+Describe what you think should be done to address this issue. If you don’t have a suggestion, feel free to leave this blank.
+
+## Additional Information
+Include any extra details, screenshots, diagrams, or other materials that may help clarify the issue.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,31 @@
+---
+name: Feature Request
+about: Propose a new feature or improvement
+title: "[Feature] Brief description of the feature"
+labels: enhancement
+assignees: ''
+---
+
+## Summary
+Provide a concise overview of the feature or enhancement you'd like to see implemented.
+
+## Problem Statement
+Is this feature addressing a specific problem or gap? If so, describe the problem in detail and explain why it needs to be solved.
+
+## Proposed Solution
+Describe your proposed solution. How would the feature work? What are the key components or functionality it would involve?
+
+## Benefits
+Explain how this feature would improve the project. What advantages does it bring to the users or developers?
+
+## Alternatives Considered
+If applicable, mention any alternative solutions or approaches you’ve thought about and explain why they may or may not be suitable.
+
+## Additional Context
+Add any other information, screenshots, diagrams, or references that help explain the request.
+
+## Priority Level
+Please indicate the importance of this feature:
+- [ ] High: Crucial to the project’s success
+- [ ] Medium: Useful but not critical
+- [ ] Low: Nice-to-have, no urgency

.github/pull_request_template.md

@@ -0,0 +1,18 @@
+### Issue(s):
+#issueNumber
+
+### Type of change: (choose required ones)
+- Bug fix
+- New feature
+- Breaking change
+- Documentation update
+- Refactor/Optimization
+
+### Description:
+One or more sentences of description.
+
+### Additional context:
+Some additional, important things about the code (eg. the code contains a temporary solution that will soon be refactored).
+
+### Testing instructions:
+Commands and other guidance on how to test your new code.

.github/workflows/deploy-ghcr.yml

@@ -0,0 +1,41 @@
+# Deploy the Docker image to GHCR
+name: CD Deployment
+
+on:
+  push:
+    branches:
+      - dev
+      - build-system-overhaul
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      # Step 1: Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Step 2: Set up Java 21
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '21'  
+          distribution: 'temurin'
+
+      # Step 3: Build the JAR file with Maven
+      - name: Build JAR
+        run: mvn clean package
+        working-directory: backend
+
+      # Step 4: Log in to GitHub Container Registry
+      - name: Log in to GHCR
+        run: echo "${{ secrets.CONTAINER_REGISTRY_PAT }}" | docker login ghcr.io -u GerardChabaBristol --password-stdin
+
+      # Step 5: Build and push the Docker image
+      - name: Publish Docker image to GHCR
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ghcr.io/spe-uob/2024-ailearningtool:latest

.github/workflows/maven.yml

@@ -28,4 +28,7 @@ jobs:
         distribution: 'temurin'
         cache: maven
     - name: Build with Maven
-      run: mvn -B package --file pom.xml
+      run: mvn -B clean compile --file backend/pom.xml
+    - name: Test with Maven
+      run: mvn -B test --file backend/pom.xml
+

.gitignore

@@ -1,4 +1,13 @@
-target
+backend/target
 backend/.idea
+backend/src/main/resources/keystore.p12
+backend/src/main/resources/static
+
+frontend/dist
+frontend/node_modules
+
 .idea
+.env
+keystore.p12
+target
 

Dockerfile

@@ -0,0 +1,11 @@
+# Use an official OpenJDK runtime as a base image.
+FROM openjdk:21-jdk-slim
+
+# Specify the JAR file's build location.
+ARG JAR_FILE=backend/target/*.jar
+
+# Copy the JAR file into the container.
+COPY ${JAR_FILE} app.jar
+
+# Define the command to run your application.
+ENTRYPOINT ["java", "-jar", "/app.jar"]

README.md

@@ -1,4 +1,11 @@
 # 2024-AILearningTool
+
+<div align="center">
+
+![logo](frontend/src/assets/logo.png)
+
+</div>
+
 ## Table of Contents
 - [Project Brief](#project-brief)
 - [Stakeholders](#stakeholders)
@@ -92,24 +99,25 @@ Below is an overview of the key components of the system:
   - [api](/frontend/api): Includes the cookies API.
   - [public](/frontend/public): Includes some front-end documents.
   - [src](/frontend/src): Includes the front-end code.
-- [src](/src): Contains all of the back-end code (in Java) and documents:
-  - [main](/src/main): Includes the back-end code.
-  - [static](/src/main/resources/static): Includes all static documents, including index.html of the front-end.
-  - [test/java/com/UoB/AILearningTool](/src/test/java/com/UoB/AILearningTool): Includes all of the unit tests. 
+- [backend](/backend): Contains all of the back-end code (in Java), Maven config and documents:
+  - [src/main](/backend/src/main): Includes the back-end Java code.
+  - [src/main/static](/backend/src/main/resources/static): Includes all static documents, including index.html of the front-end.
+  - [src/test/java/com/UoB/AILearningTool](/backend/src/test/java/com/UoB/AILearningTool): Includes all backend Java the unit tests.
+  - [mvnw]((/backend/mvnw)), [mvnw.cmd]((/backend/mvnw.cmd))  and [pom.xml](/backend/pom.xml): Documents for Maven.
 - [LICENSE](/LICENSE): Includes the project's MIT license file.
-- [mvnw](/mvnw) and [pom.xml](/pom.xml): Documents for Maven.
 
 ## Tech Stack:
 ### Frontend
 The front end is a JavaScript Vue 3-based web application. It makes requests to the backend using HTTP requests.
 ### Backend
 The backend is based on Spring Boot (open-source Java framework).
 Data will be stored in a MariaDB database.
-User prompts for the chatbot will be sent using API requests from the Spring Boot backend to the IBM Watsonx language model.
+User prompts for the chatbot will be sent using API requests from the Spring Boot backend to the OpenAI language model.
 
-![Architecture diagram, showing the technologies used in the project.](/docs/architecture_diagram.png)
+![architecture_diagram](/docs/architecture_diagram.png)
 
 ## User Instructions:
+
 1. **Open the Web App**:  
 
    Using any device with internet access (smartphone, tablet, laptop, etc.), open a web browser and navigate to the provided link [insert URL here].
@@ -172,15 +180,26 @@ To get started with developing or contributing to this project, follow the steps
 
 5. **Install Vue and Yarn**:
    The front end of this project is built using Vue 3 and Yarn, so make sure you have them installed: 
-   - Vue 3 installation guide [here](https://v3.ru.vuejs.org/guide/installation.html)
+   - Vue 3 installation guide [here](https://vuejs.org/guide/quick-start.html)
    - Yarn installation guide [here](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
 
 6. **Open the Project in Your IDE**:
    Open the cloned repository in your preferred Integrated Development Environment (IDE) (we recommend IntelliJ) for further development.
 
-7. **Test and Run the Server**:
+7. **Add keystore.p12 file to backend/src/main/resources in the cloned repository**:
+    Keystore has to contain both private key and full certificate chain files.
+    Not adding the keystore file will result in unencrypted (non-HTTPS) connection.
+
+8. **Test and Run the Server**:
    - To run the unit tests, use the command ```mvn test```
-   - To start the server, use the command ```mvn spring-boot:run```
+   - To start the server, use the script ```startServer.sh```
+
+9. **Continuous Deployment (CD) with Docker and GHCR**:
+  Our project includes Continuous Deployment (CD) with Docker and GitHub Container Registry (GHCR). Every time changes are pushed to the dev branch, a new Docker image is automatically built and pushed to our [GHCR repository](https://ghcr.io/spe-uob/2024-ailearningtool:latest).
+  To pull the latest Docker image from GHCR and update the application on the server, follow these steps:
+    - Start the Docker service: ```sudo systemctl start docker```
+    - Run the pull script: ```./pull-from-ghcr.sh```
+
 
 ## Team Members: