add readme and pm collection

rvarun11 · Oct 19, 2023 · 0ce8c9a · 0ce8c9a
1 parent 9030c2c
commit 0ce8c9a
Show file tree

Hide file tree

Showing 3 changed files with 333 additions and 2 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -10,7 +10,7 @@
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	"features": {
-    	"ghcr.io/devcontainers/features/common-utils:2": {
+		"ghcr.io/devcontainers/features/common-utils:2": {
 			"configureZshAsDefaultShell": true
 		},
 		"ghcr.io/itsmechlark/features/rabbitmq-server:1" : {

diff --git a/README.md b/README.md
@@ -1 +1,35 @@
-[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/I8UeB_vA)
+# ACME RUN - Liuyin, Samkith, Varun
+
+Welcome to our implementation of ACME RUN, a collaborative project developed by Liuyin, Samkith, and Varun as part of CAS 735 (Fall 2023).
+
+## Installation
+
+1. Clone the Repository:
+```bash
+git clone https://github.com/CAS735-F23/macrun-teamvsl.git
+cd macrun-teamvsl
+```
+
+2. Run Docker Compose
+```bash
+docker compose up
+```
+
+## Getting Started
+
+Now that you have the project running, follow these steps to get started:
+
+1. **Import Postman Collection**:
+- Import the provided Postman Collection into your Postman workspace.
+- The collection includes predefined API requests for ACME RUN.
+
+2. **Run APIs**:
+- Execute the API requests from the top of the Postman Collection.
+- Explore and interact with the various endpoints available in ACME RUN.
+
+
+## Contributors
+
+- Liuyin Shi ([email protected])
+- Samkith Jain ([email protected])
+- Varun Rajput ([email protected])
diff --git a/apis.postman_collection.json b/apis.postman_collection.json
@@ -0,0 +1,297 @@
+{
+	"info": {
+		"_postman_id": "9d58d4fc-4c61-4f41-9944-6d29c3b2cd9e",
+		"name": "MacRun - Liuyin, Samkith, Varun",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
+		"_exporter_id": "14312203",
+		"_collection_link": "https://winter-satellite-393249.postman.co/workspace/cas-735~2906f288-5f3e-4839-8f70-f7f36274cd09/collection/14312203-9d58d4fc-4c61-4f41-9944-6d29c3b2cd9e?action=share&source=collection_link&creator=14312203"
+	},
+	"item": [
+		{
+			"name": "Player Service",
+			"item": [
+				{
+					"name": "Create Player",
+					"event": [
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"const responseJson = pm.response.json();",
+									"const playerId = responseJson.id;",
+									"",
+									"pm.collectionVariables.set('playerId', playerId); ",
+									""
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"request": {
+						"method": "POST",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"user\": {\n        \"name\": \"Player1\",\n        \"email\": \"[email protected]\",\n        \"dob\": \"1998-07-19\"\n    },\n    \"height\": 175,\n    \"weight\": 80,\n    \"geographicalZone\": \"McMaster University\"\n\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "localhost:8000/player",
+							"host": [
+								"localhost"
+							],
+							"port": "8000",
+							"path": [
+								"player"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "List Players",
+					"request": {
+						"method": "GET",
+						"header": [],
+						"url": {
+							"raw": "localhost:8000/players",
+							"host": [
+								"localhost"
+							],
+							"port": "8000",
+							"path": [
+								"players"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Get Player",
+					"request": {
+						"method": "GET",
+						"header": [],
+						"url": {
+							"raw": "localhost:8000/players/{{playerId}}",
+							"host": [
+								"localhost"
+							],
+							"port": "8000",
+							"path": [
+								"players",
+								"{{playerId}}"
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		},
+		{
+			"name": "HRM Service",
+			"item": [
+				{
+					"name": "Connect HRM",
+					"request": {
+						"method": "POST",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"hrm_id\" : \"{{hrmId}}\", \n    \"connect\" : true\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "localhost:8004/hrms",
+							"host": [
+								"localhost"
+							],
+							"port": "8004",
+							"path": [
+								"hrms"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Disconnect HRM",
+					"request": {
+						"method": "POST",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"hrm_id\" : \"{{hrmId}}\", \n    \"connect\" : false\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "localhost:8004/hrms",
+							"host": [
+								"localhost"
+							],
+							"port": "8004",
+							"path": [
+								"hrms"
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		},
+		{
+			"name": "WorkoutService",
+			"item": [
+				{
+					"name": "Start Work Out",
+					"event": [
+						{
+							"listen": "prerequest",
+							"script": {
+								"exec": [
+									""
+								],
+								"type": "text/javascript"
+							}
+						},
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"const responseJson = pm.response.json();",
+									"const workoutId = responseJson.id;",
+									"",
+									"pm.collectionVariables.set('workoutId', workoutId); ",
+									""
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"request": {
+						"method": "POST",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"trailID\":\"{{trailId}}\",\n    \"playerID\":\"{{playerId}}\",\n    \"hrmConnected\":true,\n    \"hrmID\":\"{{hrmId}}\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "localhost:8001/workout",
+							"host": [
+								"localhost"
+							],
+							"port": "8001",
+							"path": [
+								"workout"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "List Workouts",
+					"request": {
+						"method": "GET",
+						"header": [],
+						"url": {
+							"raw": "localhost:8001/workouts",
+							"host": [
+								"localhost"
+							],
+							"port": "8001",
+							"path": [
+								"workouts"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Stop Work Out",
+					"request": {
+						"method": "PUT",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"workoutID\": \"4bbb5ae9-d7c4-4a24-8264-be12a2d8b5b5\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "localhost:8001/workout",
+							"host": [
+								"localhost"
+							],
+							"port": "8001",
+							"path": [
+								"workout"
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		}
+	],
+	"event": [
+		{
+			"listen": "prerequest",
+			"script": {
+				"type": "text/javascript",
+				"exec": [
+					""
+				]
+			}
+		},
+		{
+			"listen": "test",
+			"script": {
+				"type": "text/javascript",
+				"exec": [
+					""
+				]
+			}
+		}
+	],
+	"variable": [
+		{
+			"key": "playerId",
+			"value": "",
+			"type": "string"
+		},
+		{
+			"key": "hrmId",
+			"value": "",
+			"type": "string"
+		},
+		{
+			"key": "trailId",
+			"value": "",
+			"type": "string"
+		},
+		{
+			"key": "workoutId",
+			"value": "",
+			"type": "string"
+		}
+	]
+}