diff --git a/Docs/API Schemas/comment_service_api_contract.yaml b/Docs/API Schemas/comment_service_api_contract.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..2655da5ddfd9160e6ef5c92a8fcc5d1a76d37f0a
--- /dev/null
+++ b/Docs/API Schemas/comment_service_api_contract.yaml
@@ -0,0 +1,255 @@
+---
+openapi: 3.0.0
+info:
+ title: "Comment Service API"
+ description: "API which allows users to write and like comments"
+ version: 1.0.0
+servers:
+- url: "http://localhost:8000"
+
+paths:
+ /comment/{postID}:
+ get:
+ summary:
+ Retrives list of comments from the post ID
+ description:
+ Retrieves a list of comments
+ tags:
+ - Fetching Comments
+ security:
+ - JWT: []
+
+ parameters:
+ - name: postID
+ in: path
+ description: IDs of users to get
+ required: true
+ schema:
+ type: string
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CommentResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /comment/new:
+ post:
+ summary:
+ -Creates a new comment under a post
+ tags:
+ -Creating a new comment
+ security:
+ - JWT: []
+
+ requestBody:
+ - required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateCommentRequest'
+
+ responses:
+ '201':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CommentResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /comment/like:
+ post:
+ summary:
+ -Likes a comment for a user
+ tags:
+ -Likes a comment
+ security:
+ - JWT: []
+
+ requestBody:
+ - required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/LikeComment'
+
+ responses:
+ '201':
+ description: OK
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /comment/unlike:
+ post:
+ summary:
+ -Unlikes a comment for a user
+ tags:
+ -Unikes a comment
+ security:
+ - JWT: []
+
+ requestBody:
+ - required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UnlikeComment'
+
+ responses:
+ '201':
+ description: OK
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /comment/:
+ delete:
+ summary: Deletes a comment
+ security:
+ - JWT: []
+
+
+ requestBody:
+ description: commentId which needs to be deleted
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeleteComment'
+
+ responses:
+ '200':
+ description: Comment Deleted
+ '400':
+ description: Bad request. Missing required fields.
+ '404':
+ description: Comment not found
+ '500':
+ description: Internal server error
+
+components:
+ securitySchemes:
+ JWT:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+
+ schemas:
+ CommentResponse:
+ type: object
+ properties:
+ _id:
+ type: string
+ AuthorId:
+ type: string
+ PostId:
+ type: string
+ Content:
+ type: string
+ LikerIds:
+ type: array
+ items:
+ type: integer
+ IsPostAuthor:
+ type: boolean
+ __v:
+ type: integer
+ required:
+ - _id
+ - AuthorId
+ - PostId
+ - Content
+ -LikerIds
+ -IsPostAuthor
+
+
+ CreateCommentRequest:
+ type: object
+ properties:
+ postId:
+ type: string
+ userId:
+ type: string
+ Content:
+ type: string
+ required:
+ - postId
+ - userId
+ - content
+
+
+ LikeComment:
+ type: object
+ properties:
+ commentId:
+ type: string
+ userId:
+ type: string
+ required:
+ - commentId
+ - userId
+
+ UnlikeComment:
+ type: object
+ properties:
+ commentId:
+ type: string
+ userId:
+ type: string
+ required:
+ - commentId
+ - userId
+
+ DeleteComment:
+ type: object
+ properties:
+ commentId:
+ type: string
+ userId:
+ type: string
+ required:
+ - commentId
+ - userId
+
+
+
+
\ No newline at end of file
diff --git a/Docs/API Schemas/feed_service_api_contract.yaml b/Docs/API Schemas/feed_service_api_contract.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..826ae519bd50f57c6ae92ff61c360d7ec7bacf8f
--- /dev/null
+++ b/Docs/API Schemas/feed_service_api_contract.yaml
@@ -0,0 +1,275 @@
+openapi: "3.0.0"
+
+info:
+ title: "Feed API"
+ description: "API for managing user dailies"
+ version: "1.0.0"
+
+servers:
+ - url: "http://feed-service:9000"
+
+paths:
+ /daily/create:
+ post:
+ summary:
+ Create a new user daily.
+ tags:
+ - Creating a Daily
+ security:
+ - JWT: []
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateDailyRequest'
+
+ responses:
+ '201':
+ description: Daily successfully created
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DailyResponse'
+ '400':
+ description: Bad request.
+ '401':
+ description: Unauthorized request.
+ '500':
+ description: Internal server error
+
+ /user/dailies:
+ get:
+ summary: Fetch the user's dailies.
+ tags:
+ - User Dailies
+ security:
+ - JWT: []
+
+ parameters:
+ - name: user_id
+ in: path
+ description: ID of the user whose dailies to fetch
+ required: true
+ schema:
+ type: integer
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DailyResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /user/currentDaily:
+ get:
+ summary: Fetch the user's current daily.
+ tags:
+ - User Dailies
+ security:
+ - JWT: []
+
+ parameters:
+ - name: user_id
+ in: path
+ description: ID of the user whose daily to fetch
+ required: true
+ schema:
+ type: integer
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DailyResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /feed:
+ get:
+ summary:
+ Fetch a user's feed.
+ description:
+ Fetch the posts of all the user's friends.
+ tags:
+ - Fetching a User's Feed
+ security:
+ - JWT: []
+
+ parameters:
+ - name: user_id
+ in: path
+ description: ID of the user whose daily to fetch
+ required: true
+ schema:
+ type: integer
+
+ - name: question_id
+ in: path
+ description: ID of the question whose daily to fetch
+ required: true
+ schema:
+ type: integer
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FeedResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '500':
+ description: Internal server error
+
+ /daily/like:
+ post:
+ summary:
+ Like a daily.
+ tags:
+ - Liking a Daily
+ security:
+ - JWT: []
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/LikeDailyRequest'
+
+ responses:
+ '201':
+ description: Daily successfully liked.
+ '400':
+ description: Bad request.
+ '401':
+ description: Unauthorized request.
+ '500':
+ description: Internal server error
+
+ /daily/unlike:
+ post:
+ summary:
+ Unlike a daily.
+ tags:
+ - Liking a Daily
+ security:
+ - JWT: []
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/LikeDailyRequest'
+
+ responses:
+ '201':
+ description: Daily successfully unliked.
+ '400':
+ description: Bad request.
+ '401':
+ description: Unauthorized request.
+ '500':
+ description: Internal server error
+
+
+components:
+ securitySchemes:
+ JWT:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+
+ schemas:
+ CreateDailyRequest:
+ type: object
+ properties:
+ user_id:
+ type: string
+ question_id:
+ type: string
+ content:
+ type: string
+ required:
+ - user_id
+ - question_id
+ - content
+
+ LikeDailyRequest:
+ type: object
+ properties:
+ daily_id:
+ type: string
+ user_id:
+ type: string
+ required:
+ - daily_id
+ - user_id
+
+ DailyResponse:
+ type: object
+ properties:
+ _id:
+ type: string
+ user_id:
+ type: string
+ question_id:
+ type: string
+ content:
+ type: string
+ users_liked:
+ type: array
+ items:
+ type: integer
+ created_at:
+ type: string
+ format: date-time
+ required:
+ - _id
+ - user_id
+ - question_id
+ - users_liked
+ - created_at
+
+
+ FeedResponse:
+ type: object
+ properties:
+ userDaily:
+ $ref: '#/components/schemas/DailyResponse'
+ feed:
+ type: array
+ items:
+ $ref: '#/components/schemas/DailyResponse'
+
\ No newline at end of file
diff --git a/Docs/API Schemas/friends_service_api_contract.yml b/Docs/API Schemas/friends_service_api_contract.yml
new file mode 100644
index 0000000000000000000000000000000000000000..02e52247b0bb2787c213515b3306f5667d512284
--- /dev/null
+++ b/Docs/API Schemas/friends_service_api_contract.yml
@@ -0,0 +1,230 @@
+openapi: "3.0.0"
+
+info:
+ title: "Friends API"
+ description: "API for managing user's friends"
+ version: "1.0.0"
+
+servers:
+ - url: "http://localhost:8000"
+
+paths:
+ /friends:
+ get:
+ summary:
+ Get user's friends.
+ description:
+ Retrieves a list of the IDs of the user's friends.
+ tags:
+ - Getting User's Friends
+ security:
+ - JWT: []
+
+ parameters:
+ - name: user_id
+ in: query
+ description: ID of the user whose friends to retrieve
+ required: true
+ schema:
+ type: integer
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: integer
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+
+ delete:
+ summary:
+ Remove a friend
+ description:
+ Removes a friend from the user's friend list.
+ tags:
+ - Removing Friend
+ security:
+ - JWT: []
+
+ parameters:
+ - name: user_id
+ in: path
+ description: ID of the user
+ required: true
+ schema:
+ type: integer
+
+ - name: friend_id
+ in: path
+ description: ID of the user to unfriend
+ required: true
+ schema:
+ type: integer
+
+ responses:
+ '200':
+ description: OK
+ '400':
+ description: Bad Request
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+
+ /friends/requests:
+ get:
+ summary:
+ Fetch all friend requests for a user.
+ description:
+ Retrieves a list of the IDs of the friend requests the user has received.
+ tags:
+ - Friend Requests
+ security:
+ - JWT: []
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: integer
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+
+ post:
+ summary:
+ Create a friend request.
+ tags:
+ - Friend Requests
+ security:
+ - JWT: []
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ManageFriendRequestRequest'
+
+ responses:
+ '201':
+ description: Created
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+
+ /friends/requests/accept:
+ put:
+ summary:
+ Accept a friend request.
+ tags:
+ - Managing Friend Requests
+ security:
+ - JWT: []
+
+ parameters:
+ - name: request_id
+ in: path
+ description: The ID of the friend request.
+ required: true
+ schema:
+ type: string
+
+ responses:
+ '201':
+ description: Updated
+ '400':
+ description: Bad request
+ '401':
+ description: Unauthorized
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+
+ /friends/requests/reject:
+ put:
+ summary:
+ Reject a friend request.
+ tags:
+ - Managing Friend Requests
+ security:
+ - JWT: []
+
+ parameters:
+ - name: request_id
+ in: path
+ description: The ID of the friend request.
+ required: true
+ schema:
+ type: string
+
+ responses:
+ '201':
+ description: Updated
+ '400':
+ description: Bad request
+ '401':
+ description: Unauthorized
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+
+components:
+ securitySchemes:
+ JWT:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+
+ schemas:
+ ManageFriendRequestRequest:
+ type: object
+ description: Request object for creating/accepting/rejecting a friend request.
+ properties:
+ requester_id:
+ type: string
+ description: The ID of the user who is initiating the friend request.
+ receiver_id:
+ type: string
+ description: The ID of the user who is receiving the friend request.
+ required:
+ - requester_id
+ - receiver_id
diff --git a/Docs/API Schemas/question_service_api_contract.yaml b/Docs/API Schemas/question_service_api_contract.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..b4914ff0903f10a9873712c7880d85def0608302
--- /dev/null
+++ b/Docs/API Schemas/question_service_api_contract.yaml
@@ -0,0 +1,193 @@
+openapi: "3.0.0"
+
+info:
+ title: "Question Service"
+ description: "API for managing daily questions"
+ version: "1.0.0"
+
+servers:
+ - url: "http://question-service:9000"
+
+paths:
+ /question:
+ get:
+ summary:
+ Retrieve the daily question.
+ tags:
+ - Fetching Daily Question
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/QuestionResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /questions:
+ get:
+ summary:
+ Retrieve the raw questions.
+ tags:
+ - Raw Questions
+ security:
+ - JWT: []
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ items:
+ $ref: '#/components/schemas/QuestionResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /insertQuestion:
+ post:
+ summary:
+ Create a new question.
+ description:
+ Allows admins to submit a new question.
+ tags:
+ - Raw Questions
+ security:
+ - JWT: []
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateQuestionRequest'
+ responses:
+ '201':
+ description: Question successfully created
+ '400':
+ description: Bad request
+ '401':
+ description: Unauthorized request
+ '403':
+ description: Forbidden
+ '500':
+ description: Internal server error
+
+ /disableQuestion:
+ post:
+ summary:
+ Disables a question.
+ description:
+ Allows admins to disable a raw question.
+ tags:
+ - Raw Questions
+ security:
+ - JWT: []
+
+ parameters:
+ - name: question_id
+ in: path
+ description: ID of the question to disable
+ required: true
+ schema:
+ type: string
+
+ responses:
+ '201':
+ description: Question successfully disabled
+ '400':
+ description: Bad request
+ '401':
+ description: Unauthorized request
+ '403':
+ description: Forbidden
+ '500':
+ description: Internal server error
+
+
+components:
+ securitySchemes:
+ JWT:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+
+ schemas:
+ CreateQuestionRequest:
+ type: object
+ properties:
+ question:
+ type: string
+ required:
+ - question
+
+ DailyQuestionResponse:
+ type: object
+ properties:
+ _id:
+ type: integer
+ question_id:
+ type: integer
+ question_text:
+ type: string
+ format: object
+ next_question_at:
+ type: string
+ format: date-time
+ created_at:
+ type: string
+ format: date-time
+ updated_at:
+ type: string
+ format: date-time
+ required:
+ - _id
+ - question_id
+ - question_text
+ - next_question_at
+ - created_at
+ - updated_at
+
+ QuestionResponse:
+ type: object
+ properties:
+ _id:
+ type: string
+ content:
+ type: string
+ format: object
+ used:
+ type: integer
+ disabled:
+ type: boolean
+ created_at:
+ type: string
+ format: date-time
+ updated_at:
+ type: string
+ format: date-time
+ required:
+ - _id
+ - content
+ - used
+ - disabled
+ - created_at
+ - updated_at
diff --git a/Docs/API Schemas/user_service_api_contract.yaml b/Docs/API Schemas/user_service_api_contract.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..61d7912a7807669a5a5a7ef35f182ab6bee56f56
--- /dev/null
+++ b/Docs/API Schemas/user_service_api_contract.yaml
@@ -0,0 +1,341 @@
+openapi: "3.0.0"
+
+info:
+ title: "User Service API"
+ description: "API for querying users"
+ version: "1.0.0"
+
+servers:
+ - url: "http://localhost:8000"
+
+paths:
+ /userlist:
+ post:
+ summary:
+ Retrieve a list of user objects from a list of user id's
+ description:
+ Retrieves a list of users
+ tags:
+ - Fetching Users
+ security:
+ - JWT: []
+
+ parameters:
+ - name: user_ids
+ in: query
+ description: IDs of users to get
+ schema:
+ type: array
+ items:
+ type: string
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /user/{username}:
+ get:
+ summary:
+ Profile information such as name (first, last), email.
+ description:
+ Retrieves information of user
+ tags:
+ - Fetching Users
+ security:
+ - JWT: []
+
+ parameters:
+ - name: user_ids
+ in: query
+ description: profile information
+ schema:
+ type: string
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /register:
+ post:
+ summary:
+ Creates a new user.
+ tags:
+ - Creating a User
+ security:
+ - JWT: []
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateUserRequest'
+
+ responses:
+ '201':
+ description: User successfully created
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ '400':
+ description: Bad request.
+ '401':
+ description: Unauthorized request.
+ '409':
+ description: Conflict. A user with the same email or username already exists.
+
+
+ /search:
+ get:
+ summary:
+ Search users by username or name (first or last)
+ description:
+ Retrieves a list of users whose username/first name/last name start with the given string.
+ tags:
+ - Fetching Users
+ security:
+ - JWT: []
+
+ parameters:
+ - name: Username or Name
+ in: query
+ description: The username query.
+ required: true
+ schema:
+ type: string
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserResponse2'
+ '400':
+ description: Bad Request
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '500':
+ description: Internal server error
+
+ /updateuser:
+ put:
+ summary: Update information of existing user.
+ tags:
+ - Editing a User
+ security:
+ - JWT: []
+
+ parameters:
+ - name: user_id
+ in: path
+ description: ID of the user to update
+ required: true
+ schema:
+ type: integer
+
+ requestBody:
+ description: User object that needs to be updated
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/EditUserRequest'
+
+ responses:
+ '200':
+ description: User updated successfully
+ '400':
+ description: Bad request. User input is invalid or missing required fields.
+ '404':
+ description: User not found
+ '500':
+ description: Internal server error
+
+
+ /login:
+ post:
+ summary:
+ Login a user and return a JWT token.
+ description:
+ Logs in a user and returns a JWT token for authorization.
+ tags:
+ - Login
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - username
+ - password
+ properties:
+ username:
+ type: string
+ description: The user's username.
+ password:
+ type: string
+ description: The user's password.
+ format: password
+
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ token:
+ type: string
+ description: The JWT token to use for authorization.
+ user:
+ $ref: '#/components/schemas/UserResponse'
+ '401':
+ description: Unauthorized
+ '500':
+ description: Internal server error
+
+
+components:
+ securitySchemes:
+ JWT:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+
+ schemas:
+ CreateUserRequest:
+ type: object
+ properties:
+ email:
+ type: string
+ format: email
+ username:
+ type: string
+ password:
+ type: string
+ first_name:
+ type: string
+ last_name:
+ type: string
+ about:
+ type: string
+ profile_pic:
+ type: string
+ format: binary
+ required:
+ - email
+ - username
+ - password
+
+ EditUserRequest:
+ type: object
+ properties:
+ email:
+ type: string
+ format: email
+ first_name:
+ type: string
+ last_name:
+ type: string
+ about:
+ type: string
+ profile_pic:
+ type: string
+ format: binary
+
+ UserResponse:
+ type: object
+ properties:
+ _id:
+ type: string
+ email:
+ type: string
+ format: email
+ username:
+ type: string
+ first_name:
+ type: string
+ last_name:
+ type: string
+ about:
+ type: string
+ profile_pic:
+ type: string
+ format: binary
+ created_at:
+ type: string
+ format: date-time
+ updated_at:
+ type: string
+ format: date-time
+ required:
+ - _id
+ - email
+ - username
+ - first_name
+ - last_name
+ - created_at
+ - updated_at
+
+ UserResponse2:
+ type: object
+ properties:
+ _id:
+ type: string
+ username:
+ type: string
+ admin:
+ type: boolean
+ profile:
+ type: string
+ __v:
+ type: integer
+ required:
+ - _id
+ - username
+ - admin
+ - profile
+ - __v
+ - created_at
+ - updated_at
diff --git a/README.md b/README.md
index dc9e3816d25ee14c9c135f020f28bb95c8240db1..19c0f892d09bac9cd8eda80bb7feac7034602e4f 100644
--- a/README.md
+++ b/README.md
@@ -1,92 +1,43 @@
-# Daily Thought App
+# Daily - A Web Application
+Application URL: http://35.230.140.48/.
+Everyday at a random time between the morning and the afternoon, a new question is released - this is called the Daily Question. The mind-bending, head-scratching question is provided to all the users so they can answer it. A user's answer is called a **Daily**, and they can only post one Daily per question. Using the feed, a user can see all of their friend's intriguing, fresh, and controversial Dailies.They can read, comment, and like their friends' Dailies as they please.
-## Getting started
+## Members
+**All members of Group 6:**
+- Shaikh Rezwan Rafid Ahmad 6732715
+- Felipe D'Abrantes 6569390
+- Matt Kirby 6572050
+- Venkatesh Nagasubramanian 6721597
+- Patrick Talty-Kerr 6583333
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## Services
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+| Service | Description | Technology |
+|----------|-----------------------------------|----------------------|
+| User | Manages users. | Node.js |
+| Friends | Manages friendships and requests. | Node.js |
+| Question | Manages the daily questions. | Node.js |
+| Feed | Manages the Dailies. | Scala Play Framework |
+| Comment | Manages the comments of Dailies. | Node.js |
-## Add your files
+## Other Technologies Used
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+- MongoDB: Database system.
+- Docker: Containerization tool for containerising services.
+- Kubernetes: Container orchestration tool for scaling and managing the containers.
+- NGINX: Reverse proxy for handling incoming requests.
+- Google Cloud Platform: Cloud infrastructure for deploying the application.
-```
-cd existing_repo
-git remote add origin https://gitlab.surrey.ac.uk/com3014-coursework/daily-thought-app.git
-git branch -M main
-git push -uf origin main
-```
+## Running Locally
-## Integrate with your tools
+Navigate to root folder and run:
-- [ ] [Set up project integrations](https://gitlab.surrey.ac.uk/com3014-coursework/daily-thought-app/-/settings/integrations)
+`docker compose up --build`
-## Collaborate with your team
+Application is exposed on http://localhost:8080/.
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+## Deployment
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
-
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+Instructions for deployment on Google Cloud can be found on [Deployment Steps](./gcloud/Deployment%20Steps.md).
diff --git a/backend-services/comment-service-2/config.ts b/backend-services/comment-service-2/config.ts
index 1f3e667307779775a9de031eeb908692e4a32843..a67abdd596ea3ae57ec1fe5961a18dba0a080c36 100644
--- a/backend-services/comment-service-2/config.ts
+++ b/backend-services/comment-service-2/config.ts
@@ -1,3 +1,3 @@
export default {
- JWT_SECRET: "yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I="
+ JWT_SECRET: "jwtprivatekey"
}
diff --git a/backend-services/feed-service/app/repositories/QuestionRepository.scala b/backend-services/feed-service/app/repositories/QuestionRepository.scala
index 053be38a1bffc55d644d8deff4ed8eed462d3f7c..9c12a5abce66604faddf0cdbe880246d524bc4b6 100644
--- a/backend-services/feed-service/app/repositories/QuestionRepository.scala
+++ b/backend-services/feed-service/app/repositories/QuestionRepository.scala
@@ -37,7 +37,7 @@ object QuestionRepository {
try {
Question.createQuestionAsync("What is your favourite food?")
Question.createQuestionAsync("What is your dream holiday destination?")
- Question.createQuestionAsync("What us your favourite local spot?")
+ Question.createQuestionAsync("What is your favourite local spot?")
println("Successfully seeded Question Database!")
} catch {
diff --git a/backend-services/friend-service/config.ts b/backend-services/friend-service/config.ts
index 1f3e667307779775a9de031eeb908692e4a32843..a67abdd596ea3ae57ec1fe5961a18dba0a080c36 100644
--- a/backend-services/friend-service/config.ts
+++ b/backend-services/friend-service/config.ts
@@ -1,3 +1,3 @@
export default {
- JWT_SECRET: "yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I="
+ JWT_SECRET: "jwtprivatekey"
}
diff --git a/backend-services/user-service/config.js b/backend-services/user-service/config.js
index d17b31d89a1bacfb8ead7dc52b49c3413b419c6d..24366e7e1dfaaaaed0fddc10977993c89c766251 100644
--- a/backend-services/user-service/config.js
+++ b/backend-services/user-service/config.js
@@ -1,3 +1,3 @@
export default {
- JWT_SECRET : "yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I="
+ JWT_SECRET : "jwtprivatekey"
}
\ No newline at end of file
diff --git a/docker-compose.yml b/docker-compose.yml
index 3cd75caa960512a6cf43ded34a848f2f1d161989..b48cb5a755eb961c91c0ec92123d7a39de48bc52 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -19,8 +19,8 @@ services:
- "9000"
environment:
- MONGO_URI=mongodb://feed-mongo:27017/
- - JWT_PRIVATE_KEY=yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I=
- - PLAY_HTTP_SECRET_KEY=DUvbrcM2AbuB7oXboI1x`ZI_?1Iou>/ch2@lFXfrvVkWlHuA848y?GyR/0i2Ma:A
+ - JWT_PRIVATE_KEY=jwtprivatekey
+ - PLAY_HTTP_SECRET_KEY=playhttpsecretkey
- FRIEND_SERVICE_URI=http://friend-service:9000/
- ENABLE_QUESTION_DB_SEEDING=true
@@ -34,9 +34,9 @@ services:
- "9000"
environment:
- MONGO_URI=mongodb://user-mongo:27017/userdb
- - JWT_PRIVATE_KEY=yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I=
+ - JWT_PRIVATE_KEY=jwtprivatekey
- ENABLE_USER_DB_SEEDING=true
- - SEEDED_ADMIN_PASSWORD=doesntreallymatter
+ - SEEDED_ADMIN_PASSWORD=seededadminpassword
friend-service:
build:
@@ -50,7 +50,7 @@ services:
- MONGO_HOST=friend-mongo
- MONGO_PORT=27017
- MONGO_DBNAME=friends
- - JWT_PRIVATE_KEY=yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I=
+ - JWT_PRIVATE_KEY=jwtprivatekey
comment-service:
build:
@@ -64,7 +64,7 @@ services:
- MONGO_HOST=comment-mongo
- MONGO_PORT=27017
- MONGO_DBNAME=comments
- - JWT_PRIVATE_KEY=yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I=
+ - JWT_PRIVATE_KEY=jwtprivatekey
frontend-service:
build:
diff --git a/gcloud/comment-mongo/comment-mongo-deployment.yaml b/gcloud/comment-mongo/comment-mongo-deployment.yaml
index 3534555e8243728c12c16bca607c75f53d9fd9d0..df7b730b869d7ca0d57ff955c3127e88503fb3a9 100644
--- a/gcloud/comment-mongo/comment-mongo-deployment.yaml
+++ b/gcloud/comment-mongo/comment-mongo-deployment.yaml
@@ -20,6 +20,13 @@ spec:
volumeMounts:
- name: mongo-data
mountPath: /data/db
+ resources:
+ requests:
+ cpu: 100m
+ memory: 256Mi
+ limits:
+ cpu: 1000m
+ memory: 2Gi
volumes:
- name: mongo-data
persistentVolumeClaim:
diff --git a/gcloud/comment-service/comment-service-deployment.yaml b/gcloud/comment-service/comment-service-deployment.yaml
index e71598114c477118beec7badda59d44a5f85615b..346d549e5b85915461a0bcb7f92aa2784a247ce0 100644
--- a/gcloud/comment-service/comment-service-deployment.yaml
+++ b/gcloud/comment-service/comment-service-deployment.yaml
@@ -25,7 +25,14 @@ spec:
- name: MONGO_DBNAME
value: "comments"
- name: JWT_PRIVATE_KEY
- value: "yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I="
+ value: "jwtprivatekey"
+ resources:
+ requests:
+ cpu: 100m
+ memory: 128Mi
+ limits:
+ cpu: 1000m
+ memory: 1Gi
---
apiVersion: v1
kind: Service
diff --git a/gcloud/feed-mongo/feed-mongo-deployment.yaml b/gcloud/feed-mongo/feed-mongo-deployment.yaml
index 62948b4c598c831d113e7b391b0f6bb9eee0c768..efd6f0ed71d40987004132457542016ba1d15b47 100644
--- a/gcloud/feed-mongo/feed-mongo-deployment.yaml
+++ b/gcloud/feed-mongo/feed-mongo-deployment.yaml
@@ -17,6 +17,13 @@ spec:
image: mongo
ports:
- containerPort: 27017
+ resources:
+ requests:
+ cpu: 100m
+ memory: 256Mi
+ limits:
+ cpu: 1000m
+ memory: 2Gi
volumeMounts:
- name: mongo-data
mountPath: /data/db
diff --git a/gcloud/feed-service/feed-service-deployment.yaml b/gcloud/feed-service/feed-service-deployment.yaml
index 59e7f2c9d4aaf1d151b8897582a50e8b53cf5e6e..ce176f259d6f4963ebf6e684778ee8754d352745 100644
--- a/gcloud/feed-service/feed-service-deployment.yaml
+++ b/gcloud/feed-service/feed-service-deployment.yaml
@@ -25,9 +25,16 @@ spec:
- name: ENABLE_QUESTION_DB_SEEDING
value: "true"
- name: JWT_PRIVATE_KEY
- value: "yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I="
+ value: "jwtprivatekey"
- name: PLAY_HTTP_SECRET_KEY
- value: "DUvbrcM2AbuB7oXboI1x`ZI_?1Iou>/ch2@lFXfrvVkWlHuA848y?GyR/0i2Ma:A"
+ value: "playhttpsecretkey"
+ resources:
+ requests:
+ cpu: 100m
+ memory: 256Mi
+ limits:
+ cpu: 1000m
+ memory: 2Gi
---
apiVersion: v1
kind: Service
diff --git a/gcloud/friend-mongo/friend-mongo-deployment.yaml b/gcloud/friend-mongo/friend-mongo-deployment.yaml
index 80380df902b98443f4b19ca812ae08716606b5f3..fc0b99c5f79a7fb111923091b1a396edf0bc97c4 100644
--- a/gcloud/friend-mongo/friend-mongo-deployment.yaml
+++ b/gcloud/friend-mongo/friend-mongo-deployment.yaml
@@ -17,6 +17,13 @@ spec:
image: mongo
ports:
- containerPort: 27017
+ resources:
+ requests:
+ cpu: 100m
+ memory: 256Mi
+ limits:
+ cpu: 1000m
+ memory: 2Gi
volumeMounts:
- name: mongo-data
mountPath: /data/db
diff --git a/gcloud/friend-service/friend-service-deployment.yaml b/gcloud/friend-service/friend-service-deployment.yaml
index a6ab027fb41da3594ed09693ce1e3340b77822f5..3ffa326fdc15ff4f9b7e2f57b91a278f23eb244a 100644
--- a/gcloud/friend-service/friend-service-deployment.yaml
+++ b/gcloud/friend-service/friend-service-deployment.yaml
@@ -25,7 +25,14 @@ spec:
- name: MONGO_DBNAME
value: "friends"
- name: JWT_PRIVATE_KEY
- value: "yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I="
+ value: "jwtprivatekey"
+ resources:
+ requests:
+ cpu: 100m
+ memory: 128Mi
+ limits:
+ cpu: 1000m
+ memory: 1Gi
---
apiVersion: v1
kind: Service
diff --git a/gcloud/frontend-service/frontend-service-deployment.yaml b/gcloud/frontend-service/frontend-service-deployment.yaml
index bceeac19dd6ba3e627e7f2196b3fbf1e4d6eecc0..2304db0099063551462278c02a559911bbece080 100644
--- a/gcloud/frontend-service/frontend-service-deployment.yaml
+++ b/gcloud/frontend-service/frontend-service-deployment.yaml
@@ -17,6 +17,13 @@ spec:
image: europe-west2-docker.pkg.dev/daily-384822/daily-repo/frontend-service:v1
ports:
- containerPort: 3000
+ resources:
+ requests:
+ cpu: 100m
+ memory: 128Mi
+ limits:
+ cpu: 1000m
+ memory: 1Gi
---
apiVersion: v1
kind: Service
diff --git a/gcloud/user-mongo/user-mongo-deployment.yaml b/gcloud/user-mongo/user-mongo-deployment.yaml
index f9cae8254e78aeaa1bfd2745289d8ab4edfdeb21..52de407754fd81a2c9ff7aee2b7dee7b4fbe2a28 100644
--- a/gcloud/user-mongo/user-mongo-deployment.yaml
+++ b/gcloud/user-mongo/user-mongo-deployment.yaml
@@ -17,6 +17,13 @@ spec:
image: mongo
ports:
- containerPort: 27017
+ resources:
+ requests:
+ cpu: 100m
+ memory: 256Mi
+ limits:
+ cpu: 1000m
+ memory: 2Gi
volumeMounts:
- name: mongo-data
mountPath: /data/db
diff --git a/gcloud/user-service/user-service-deployment.yaml b/gcloud/user-service/user-service-deployment.yaml
index 0eda05aa68c63a7c722180b7d608df53ef7f758c..3b46cd296d1cc8992acf78b480445e088e0cb668 100644
--- a/gcloud/user-service/user-service-deployment.yaml
+++ b/gcloud/user-service/user-service-deployment.yaml
@@ -23,9 +23,16 @@ spec:
- name: ENABLE_USER_DB_SEEDING
value: "true"
- name: SEEDED_ADMIN_PASSWORD
- value: "doesntreallymatter"
+ value: "seededadminpassword"
- name: JWT_PRIVATE_KEY
- value: "yB/uX5KdyjHN9P34IE49HxAcrlQ4gfvpVJEzGbo5E/I="
+ value: "jwtprivatekey"
+ resources:
+ requests:
+ cpu: 100m
+ memory: 128Mi
+ limits:
+ cpu: 1000m
+ memory: 1Gi
---
apiVersion: v1
kind: Service