Feedback

.env.example

@@ -0,0 +1,18 @@
+# If using mongoDB containerization, set to true. Else set to false (i.e local testing)
+DB_REQUIRE_AUTH=true
+
+# mongoDB auth variables
+MONGO_USER=user
+MONGO_PASSWORD=password
+MONGO_INITDB_ROOT_USERNAME=admin # must match docker-compose.yml and init-mongo.js
+MONGO_INITDB_ROOT_PASSWORD=password # must match docker-compose.yml and init-mongo.js
+
+# mongoDB connection string variables
+DB_HOST=localhost
+DB_PORT=27017
+
+# Service database names
+PEERPREP_QUESTION_INITDB_NAME=peerprepQuestionServiceDB # must match question service .env file and init-mongo.js
+PEERPREP_USER_INITDB_NAME=peerprepUserServiceDB # must match user service .env file and init-mongo.js
+PEERPREP_MATCHING_INITDB_NAME=peerprepMatchingServiceDB # must match user service .env file and init-mongo.js
+PEERPREP_COLLABORATION_INITDB_NAME=peerprepCollaborationServiceDB # must match collab service .env file and init-mongo.js

.github/workflows/collab.yml

@@ -0,0 +1,34 @@
+name: Collaboration Service CI
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "backend/collaboration-service/**"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "backend/collaboration-service/**"
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18.x"
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: backend/collaboration-service
+
+      - name: Run Tests
+        run: npm test
+        working-directory: backend/collaboration-service

.github/workflows/frontend.yml

@@ -0,0 +1,34 @@
+name: Frontend CI
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "frontend/**"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "frontend/**"
+
+jobs:
+  run-eslint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18.x"
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: frontend
+
+      - name: Run ESLint
+        run: npm run lint
+        working-directory: frontend

.gitignore

@@ -0,0 +1,52 @@
+# General
+node_modules/
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+.DS_Store
+Thumbs.db
+*.log
+*.log.*
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+*.http
+
+# Backend
+/backend/node_modules/
+/backend/dist/
+/backend/.env
+/backend/*.log
+
+# Docker database files
+/data
+
+# Production
+/build
+/dist
+
+# Optional: Exclude specific files that might contain sensitive data or are specific to your IDE
+/.vscode/
+/.idea/
+*.swp
+*.swo
+
+# Optional: MacOS and Windows system files
+.AppleDouble
+.LSOverride
+Icon
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+/user-service/user-service/.env
+/backend/user-service/.env
+/frontend/.env
+/addon/chat/Chatio/obj
+/addon/chat/Chatio/Properties/PublishProfiles
+/addon/chat/Chatio/Properties/ServiceDependencies/Chatiox - Web Deploy
+/addon/chat/Chatio/.vs/Chatio
+/addon/chat/Chatio/bin
+/backend/collaboration-service/coverage

MongoDockerGuide.md

@@ -0,0 +1,31 @@
+Yo, this is Kevin/Nephelite and this file is an informal guide into using docker for MongoDB.
+
+Set-up:
+1. Install mongoDB (https://www.mongodb.com/docs/manual/installation/) and Docker (https://docs.docker.com/engine/install/)
+2. Set up .env files (you can just rename the .env.example to .env). If you make any changes to the .env file in the root such
+that it's different from .env.example, copy and paste the root .env into the other .env files in each microservice.
+3. Ensure the .env variables match the docker-compose.yml and init-mongo.js files because apparently they can't read the .env files?
+4. In the project root folder, run `docker-compose build --no-cache` to build the mongoDB service.
+5. Run `docker-compose up -d` to initialize and run the mongoDB service (and everything else).
+
+And everything should work in a bit. Give it a few seconds, maybe a minute at most, and everything should be up.
+Note: The green ticks that appear are just for indicating that the start up is successful. 
+The databases might not be set up yet, even if the terminal claims everything is set up and running.
+
+Stop running:
+1. Run `docker-compose down -v` to stop the services.
+2. If you want to do a full complete reset on the databases, delete the data folder with `rm -rf ./data/db`, 
+or just delete the data folder in the root directory manually if you despise the `rm -rf` command.
+
+View databases:
+1. Verify that you have access to `mongosh`. If you installed the latest mongoDB version, you *should* have it.
+2. Run `docker exec -it <mongo container name> mongosh --host <DB host> -u <mongodb root user username> -p <mongodb root user password> --authenticationDatabase admin`. By the project's default values, the command will be `docker exec -it peerprep-mongo-container mongosh --host localhost -u admin -p password --authenticationDatabase admin`.
+3. In the mongosh:
+    1. View all databases with `show dbs`.
+    2. Navigate into a database with `use <databaseName>`. 
+    3. View all collections in the database with `show collections`.
+    4. Use `db.<collection name>.find().pretty()` to view all entries in the collection.
+
+Another warning about viewing databases: If you immediately try to run `docker exec` after doing `docker-compose up -d`, 
+mongoDB will refuse the connection because it's still running setup operations from init-mongo.js. 
+Just wait for awhile before running the command again.

README.md

@@ -1,7 +1,100 @@
 # CS3219 Project (PeerPrep) - AY2425S1
-## Group: Gxx
+## Group: G25
 
-### Note: 
-- You can choose to develop individual microservices within separate folders within this repository **OR** use individual repositories (all public) for each microservice. 
-- In the latter scenario, you should enable sub-modules on this GitHub classroom repository to manage the development/deployment **AND** add your mentor to the individual repositories as a collaborator. 
-- The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements. 
+### Overview
+This project follows a microservices architecture with the following services:
+1. **Frontend** - Port `3000`
+2. **User Service** - Port `3001`
+3. **Question Service** - Port `3002` 
+4. **Matching Service** - Port `3003`
+5. **Collaboration Service** - Port `3004`
+6. **MongoDB** - Port `27017` (Database)
+7. **Nginx API Gateway** - Port `80`
+8. **Redis** - Port `6379`
+9. **Zookeeper** - Port `2181`
+10. **Kafka** - Port `9092`, Port `29092`
+11. **Chat Service** (Located in addon/chat)
+
+### Setting up the Project
+
+### Running the Project with `start.sh`
+
+A `start.sh` script is provided in the root directory to simplify setup. This script will start all services, check for any `.env.example` files, and create the required `.env` files if they don’t already exist.
+
+To run the project, open a terminal in the `cs3219-ay2425s1-project-g25` directory and execute:
+
+    ./start.sh
+
+This script can be run on **Linux**, **macOS**, and **Windows** (with Git Bash or WSL). It will initialize all services and ensure the environment files are set up as needed. 
+
+Ensure the script has execute permissions. If needed, set them by running:
+
+    chmod +x start.sh
+
+
+This will initialize all services and ensure the environment files are set up as needed. Note that running `start.sh` requires Git Bash, WSL, or a similar terminal environment capable of executing Bash scripts.
+
+### Manual Setup
+Copy and paste the .env.example files in each service. Rename them as .env files.
+Files to do this in:
+1. ./
+2. /frontend
+3. /backend/user-service
+4. /backend/question-service
+5. /backend/matching-service
+6. /backend/collaboration-service
+
+Then, run `node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"` twice to generate
+your 2 JWT token secrets. For the first one, paste it into the JWT_ACCESS_TOKEN_SECRET variable of
+the .env files in question-service and user-service. Then, copy the second into the
+JWT_REFRESH_TOKEN_SECRET of the .env file in user-service. 
+
+Further note: The DB_CLOUD_URI .env variable in user-service doesn't need to be filled in. A local
+database will be created in the mongoDB service. 
+
+Consult the readme files in each service if there are further configurations needed.
+
+### Running the Project
+
+To run the main services, execute the following command in the root directory:
+
+`docker-compose up --build`
+
+To run the chat service, navigate to the addon/chat directory and run:
+
+`docker-compose up --build`
+
+Once the containers are up:
+- Frontend: [http://localhost:3000](http://localhost:3000)
+- User Service: [http://localhost:3001](http://localhost:3001)
+- Question Service: [http://localhost:3002](http://localhost:3002)
+- Matching Service: [http://localhost:3003](http://localhost:3003)
+- Collaboration Service: [http://localhost:3004](http://localhost:3004)
+- MongoDB: [http://localhost:27017](http://localhost:27017)
+- Nginx API Gateway: [http://localhost:80](http://localhost:80)
+- Redis: [http://localhost:6379](http://localhost:6379)
+- Zookeeper: [http://localhost:2181](http://localhost:2181)
+- Kafka: [http://localhost:9092](http://localhost:9092)
+- Chat Service: Available through the main application
+
+Note that even after docker says that everything is up and running, there is a risk that they aren't when you load the frontend. Wait for the frontend logs to show up in the docker logs.
+In this event, wait for about a minute before trying again. If that still doesn't work and there are network errors, try
+rebuilding the services by running `docker-compose up --build` again.
+
+### MongoDB Configuration
+
+- MongoDB runs on port `27017` inside a container named `peerprep-mongo-container`.
+- It is initialized with:
+  - **Username**: `admin`
+  - **Password**: `password`
+- Data is persisted in the `./data/db` directory, and the `init-mongo.js` script initializes the database on startup.
+
+### Nginx API Gateway
+
+- Nginx runs on port `80` and acts as the API gateway for routing requests to the respective services.
+
+### Kubernetes Auto Pod Scaling
+
+All files for Kubernetes deployment and auto scaling of services can be found in the `/kubernetes/` folder.
+
+Refer to the [README](/kubernetes/README.md) in the kubernetes folder for more information.

addon/chat/Chatio/Chatio.csproj

@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <UserSecretsId>ebee6fc2-2cd0-4bfd-8580-ad97b28e9c5c</UserSecretsId>
+    <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.10" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.10" />
+    <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.6" />
+    <PackageReference Include="MongoDB.Driver" Version="3.0.0" />
+    <PackageReference Include="OpenAI" Version="2.0.0" />
+    <PackageReference Include="StackExchange.Redis" Version="2.8.16" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
+  </ItemGroup>
+
+</Project>

addon/chat/Chatio/Chatio.csproj.user

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <ActiveDebugProfile>http</ActiveDebugProfile>
+    <Controller_SelectedScaffolderID>MvcControllerEmptyScaffolder</Controller_SelectedScaffolderID>
+    <Controller_SelectedScaffolderCategoryPath>root/Common/MVC/Controller</Controller_SelectedScaffolderCategoryPath>
+    <NameOfLastUsedPublishProfile>C:\Users\Wwj\source\repos\project_ai\Chatio\Properties\PublishProfiles\Chatiox - Web Deploy.pubxml</NameOfLastUsedPublishProfile>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DebuggerFlavor>ProjectDebugger</DebuggerFlavor>
+  </PropertyGroup>
+</Project>

addon/chat/Chatio/Chatio.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.9.34723.18
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Chatio", "Chatio.csproj", "{03BC4C39-81A2-4440-A442-2B93B0C68BFA}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{03BC4C39-81A2-4440-A442-2B93B0C68BFA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{03BC4C39-81A2-4440-A442-2B93B0C68BFA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{03BC4C39-81A2-4440-A442-2B93B0C68BFA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{03BC4C39-81A2-4440-A442-2B93B0C68BFA}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {73C44709-CDEF-4DF9-8E10-62DE730AA6DE}
+	EndGlobalSection
+EndGlobal

addon/chat/Chatio/Configurations/MongoDbSettings.cs

@@ -0,0 +1,7 @@
+namespace Chatio.Configurations;
+
+public class MongoDbSettings
+{
+    public string ConnectionString { get; set; } = null!;
+    public string DatabaseName { get; set; } = null!;
+}

addon/chat/Chatio/Configurations/OpenAiSettings.cs

@@ -0,0 +1,13 @@
+namespace Chatio.Configurations;
+
+public class OpenAiSettings
+{
+    public required string ApiKey { get; set; }
+    public required string DefaultChatModel { get; set; }
+    public required string DefaultEmbeddingModel { get; set; }
+    public double DefaultTemperature { get; set; }
+    public double DefaultTopP { get; set; }
+    public double DefaultFrequencyPenalty { get; set; }
+    public double DefaultPresencePenalty { get; set; }
+    public int DefaultMaxTokens { get; set; }
+}