Feedback

.gitattributes

@@ -0,0 +1 @@
+text=auto

.github/pull_request_template.md

@@ -0,0 +1,18 @@
+## Status
+
+READY | IN DEVELOPMENT | HOLD
+
+## Description
+
+A few sentences describing the overall goals of the pull request's commits.
+
+## Screenshots
+
+A few screenshots displaying the changes made by the pull request.
+
+## Todos
+
+* [ ] Have you cleaned up your code? (Eg. remove redundant code/comments, fix warnings, refactor duplicate code etc.)
+* [ ] Have you manually tested your code extensively? (Eg. execute the happy path, try out edge cases etc.)
+* [ ] Have you linked your PR to the respective issues?
+* [ ] Have you generated documentation for your changes?

.gitignore

@@ -0,0 +1,8 @@
+node_modules
+.env
+.DS_Store
+frontend/.DS_Store
+frontend/src/components/.DS_Store
+user-service/.DS_Store
+user-service/src/.DS_Store
+frontend/src/.DS_Store

README.md

@@ -1,14 +1,78 @@
-# CS3219-AY22-23-Project-Skeleton
+# CS3219-AY22-23
 
-This is a template repository for CS3219 project.
+## Prerequisites to be installed
+
+Please install the following applications/software before proceeding to use/evolve the project
+skeleton.
+
+- Nodejs (and the npm that comes with it)
+- nodemon
+- create-react-app
+- Any IDE of your choice
+- Any Git client
+- MongoDB Community Server
+- MongoShell
+- MongoDB Compass (Optional)
+- Docker
 
 ## User Service
-1. Rename `.env.sample` file to `.env`.
-2. Create a Cloud DB URL using Mongo Atlas.
-3. Enter the DB URL created as `DB_CLOUD_URI` in `.env` file.
-4. Install npm packages using `npm i`.
-5. Run User Service using `npm run dev`.
+
+1. Copy `.env.example` file as `.env`.
+2. Update the relevant environment variables
+3. Install npm packages using `npm i`.
+4. Run User Service using `npm run dev`.
+
+## Matching Service
+
+1. Copy `.env.example` file as `.env`.
+2. Update the relevant environment variables
+3. Install npm packages using `npm i`.
+4. Run `docker run -d -e POSTGRES_PASSWORD=root -p 5455:5432 postgres`
+5. Run `npx prisma migrate dev` to update data in db or `npx prisma migrate reset` to reset db
+6. Run User Service using `npm run dev`.
+
+## Communication Service
+
+1. Copy `.env.example` file as `.env`.
+2. Update the relevant environment variables
+3. Install npm packages using `npm i`.
+4. Run User Service using `npm run dev`.
+
+## Collaboration Service
+
+1. Copy `.env.example` file as `.env`.
+2. Update the relevant environment variables
+3. Install npm packages using `npm i`.
+4. Run `docker compose up` to start redis
+5. Run Collaboration Service using `npm run dev`.
+
+## Question service
+
+1. Copy `.env.example` file as `.env`.
+2. Update the relevant environment variables
+3. Install npm packages using `npm i`.
+4. Run Question Service using `npm run dev`.
+
+## History service
+
+1. Copy `.env.example` file as `.env`.
+2. Update the relevant environment variables
+3. Install npm packages using `npm i`.
+4. Run History Service using `npm run dev`.
 
 ## Frontend
+
 1. Install npm packages using `npm i`.
 2. Run Frontend using `npm start`.
+
+## Starting with Docker compose instead (Alternate way to start up)
+
+1. Update all the relevant environment variables across all the services.
+2. Run docker compose up on the root of the project (this will start all the microservices except for frontend).
+3. Follow the instruction at [Frontend](#Frontend) to start the frontend service.
+
+## Generating API Documentation
+
+1. Follow the instructions [here](https://github.com/thedevsaddam/docgen) to install docgen
+2. Export postman collection as Collection v2.1 to docs/peerdep-api directory
+3. Run `docgen build -i peerdep-api.postman_collection.json -o api-doc.md -m` to generate documentation

collaboration-service/.dockerignore

@@ -0,0 +1 @@
+node_modules

collaboration-service/.env.example

@@ -0,0 +1 @@
+LOGIN_SECRET_KEY=''

collaboration-service/.eslintrc.json

@@ -0,0 +1,15 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": { "project": "tsconfig.json" },
+  "extends": ["airbnb-base", "airbnb-typescript/base"],
+  "rules" : {
+    "@typescript-eslint/no-use-before-define": "off",
+    "class-methods-use-this": "off",
+    "@typescript-eslint/no-shadow": "off",
+    "implicit-arrow-linebreak": "off",
+    "no-param-reassign":  "off",
+    "no-promise-executor-return": "off",
+    "import/prefer-default-export": "off",
+    "consistent-return": "off"
+  }
+}

collaboration-service/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+# Keep environment variables out of version control
+.env

collaboration-service/Dockerfile

@@ -0,0 +1,7 @@
+FROM node:16-alpine
+WORKDIR /usr/collaboration-service
+COPY package.json .
+RUN npm install --quiet
+COPY . .
+EXPOSE 9001
+CMD ["npm", "run", "dev"]

collaboration-service/docker-compose.yml

@@ -0,0 +1,7 @@
+version: '3.8'
+services:
+  redis:
+    image: redis:6.2-alpine
+    container_name: redis-6
+    ports:
+      - "6379:6379"