diff --git a/OPENAPI_EG_DOCS.yaml b/OPENAPI_EG_DOCS.yaml new file mode 100644 index 0000000..ac00a34 --- /dev/null +++ b/OPENAPI_EG_DOCS.yaml @@ -0,0 +1,26 @@ +openapi: 3.0.4 +info: + title: Sample API + description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML. + version: 0.1.9 + +servers: + - url: http://api.example.com/v1 + description: Optional server description, e.g. Main (production) server + - url: http://staging-api.example.com + description: Optional server description, e.g. Internal staging server for testing + +paths: + /users: + get: + summary: Returns a list of users. + description: Optional extended description in CommonMark or HTML. + responses: + "200": # status code + description: A JSON array of user names + content: + application/json: + schema: + type: array + items: + type: string \ No newline at end of file diff --git a/README.md b/README.md index e6a0a35..b2854f4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ +[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/QUdQy4ix) # CS3219 Project (PeerPrep) - AY2526S1 -## Group: Gxx +## Group: G04 ### Note: - You are required to develop individual microservices within separate folders within this repository. diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..b45c9c3 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,31 @@ +### Current structure of backend +``` +backend/ +├── docs/ +├── services/ +│ ├── collaboration_service/ +│ │ └── src/ +│ │ └── README.md +│ │ ├── docs/ +│ │ ├── api/ +│ │ ├── diagrams/ +│ ├── matching_service/ +│ │ └── src/ +│ │ └── README.md +│ │ ├── docs/ +│ │ ├── api/ +│ │ ├── diagrams/ +│ ├── question_service/ +│ │ └── src/ +│ │ └── README.md +│ │ ├── docs/ +│ │ ├── api/ +│ │ ├── diagrams/ +│ └── user_service/ +│ │ └── src/ +│ │ └── README.md +│ │ ├── docs/ +│ │ ├── api/ +│ │ ├── diagrams/ +└── README.md +``` \ No newline at end of file diff --git a/backend/docs/diagrams/to_del.png b/backend/docs/diagrams/to_del.png new file mode 100644 index 0000000..96806f8 Binary files /dev/null and b/backend/docs/diagrams/to_del.png differ diff --git a/backend/services/collaboration_service/README.md b/backend/services/collaboration_service/README.md new file mode 100644 index 0000000..9cc8f5b --- /dev/null +++ b/backend/services/collaboration_service/README.md @@ -0,0 +1 @@ +### README for collaboration service \ No newline at end of file diff --git a/backend/services/collaboration_service/docs/api/OPENAPI_EG_DOCS.yaml b/backend/services/collaboration_service/docs/api/OPENAPI_EG_DOCS.yaml new file mode 100644 index 0000000..ac00a34 --- /dev/null +++ b/backend/services/collaboration_service/docs/api/OPENAPI_EG_DOCS.yaml @@ -0,0 +1,26 @@ +openapi: 3.0.4 +info: + title: Sample API + description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML. + version: 0.1.9 + +servers: + - url: http://api.example.com/v1 + description: Optional server description, e.g. Main (production) server + - url: http://staging-api.example.com + description: Optional server description, e.g. Internal staging server for testing + +paths: + /users: + get: + summary: Returns a list of users. + description: Optional extended description in CommonMark or HTML. + responses: + "200": # status code + description: A JSON array of user names + content: + application/json: + schema: + type: array + items: + type: string \ No newline at end of file diff --git a/backend/services/collaboration_service/docs/diagrams/to_del.png b/backend/services/collaboration_service/docs/diagrams/to_del.png new file mode 100644 index 0000000..96806f8 Binary files /dev/null and b/backend/services/collaboration_service/docs/diagrams/to_del.png differ diff --git a/backend/services/collaboration_service/src/.gitkeep b/backend/services/collaboration_service/src/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/backend/services/matching_service/README.md b/backend/services/matching_service/README.md new file mode 100644 index 0000000..1f629bc --- /dev/null +++ b/backend/services/matching_service/README.md @@ -0,0 +1 @@ +### README for matching service \ No newline at end of file diff --git a/backend/services/matching_service/docs/api/OPENAPI_EG_DOCS.yaml b/backend/services/matching_service/docs/api/OPENAPI_EG_DOCS.yaml new file mode 100644 index 0000000..ac00a34 --- /dev/null +++ b/backend/services/matching_service/docs/api/OPENAPI_EG_DOCS.yaml @@ -0,0 +1,26 @@ +openapi: 3.0.4 +info: + title: Sample API + description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML. + version: 0.1.9 + +servers: + - url: http://api.example.com/v1 + description: Optional server description, e.g. Main (production) server + - url: http://staging-api.example.com + description: Optional server description, e.g. Internal staging server for testing + +paths: + /users: + get: + summary: Returns a list of users. + description: Optional extended description in CommonMark or HTML. + responses: + "200": # status code + description: A JSON array of user names + content: + application/json: + schema: + type: array + items: + type: string \ No newline at end of file diff --git a/backend/services/matching_service/docs/diagrams/to_del.png b/backend/services/matching_service/docs/diagrams/to_del.png new file mode 100644 index 0000000..96806f8 Binary files /dev/null and b/backend/services/matching_service/docs/diagrams/to_del.png differ diff --git a/backend/services/matching_service/src/.gitkeep b/backend/services/matching_service/src/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/backend/services/question_service/README.md b/backend/services/question_service/README.md new file mode 100644 index 0000000..f9f2dba --- /dev/null +++ b/backend/services/question_service/README.md @@ -0,0 +1 @@ +### README for question service \ No newline at end of file diff --git a/backend/services/question_service/docs/api/OPENAPI_EG_DOCS.yaml b/backend/services/question_service/docs/api/OPENAPI_EG_DOCS.yaml new file mode 100644 index 0000000..ac00a34 --- /dev/null +++ b/backend/services/question_service/docs/api/OPENAPI_EG_DOCS.yaml @@ -0,0 +1,26 @@ +openapi: 3.0.4 +info: + title: Sample API + description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML. + version: 0.1.9 + +servers: + - url: http://api.example.com/v1 + description: Optional server description, e.g. Main (production) server + - url: http://staging-api.example.com + description: Optional server description, e.g. Internal staging server for testing + +paths: + /users: + get: + summary: Returns a list of users. + description: Optional extended description in CommonMark or HTML. + responses: + "200": # status code + description: A JSON array of user names + content: + application/json: + schema: + type: array + items: + type: string \ No newline at end of file diff --git a/backend/services/question_service/docs/diagrams/to_del.png b/backend/services/question_service/docs/diagrams/to_del.png new file mode 100644 index 0000000..96806f8 Binary files /dev/null and b/backend/services/question_service/docs/diagrams/to_del.png differ diff --git a/backend/services/question_service/src/.gitkeep b/backend/services/question_service/src/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/backend/services/user_service/README.md b/backend/services/user_service/README.md new file mode 100644 index 0000000..e221a67 --- /dev/null +++ b/backend/services/user_service/README.md @@ -0,0 +1 @@ +### README for user service \ No newline at end of file diff --git a/backend/services/user_service/docs/api/OPENAPI_EG_DOCS.yaml b/backend/services/user_service/docs/api/OPENAPI_EG_DOCS.yaml new file mode 100644 index 0000000..ac00a34 --- /dev/null +++ b/backend/services/user_service/docs/api/OPENAPI_EG_DOCS.yaml @@ -0,0 +1,26 @@ +openapi: 3.0.4 +info: + title: Sample API + description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML. + version: 0.1.9 + +servers: + - url: http://api.example.com/v1 + description: Optional server description, e.g. Main (production) server + - url: http://staging-api.example.com + description: Optional server description, e.g. Internal staging server for testing + +paths: + /users: + get: + summary: Returns a list of users. + description: Optional extended description in CommonMark or HTML. + responses: + "200": # status code + description: A JSON array of user names + content: + application/json: + schema: + type: array + items: + type: string \ No newline at end of file diff --git a/backend/services/user_service/docs/diagrams/to_del.png b/backend/services/user_service/docs/diagrams/to_del.png new file mode 100644 index 0000000..96806f8 Binary files /dev/null and b/backend/services/user_service/docs/diagrams/to_del.png differ diff --git a/backend/services/user_service/src/.gitkeep b/backend/services/user_service/src/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 0000000..dac02d7 --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,2 @@ +### The frontend folder structure can be auto generated via nextjs build + diff --git a/to_del.png b/to_del.png new file mode 100644 index 0000000..96806f8 Binary files /dev/null and b/to_del.png differ