Add POSTMAN collection and environment for the api

Author: callmekatootie

README.md

@@ -0,0 +1,51 @@
+# Topcoder Leaderboard API
+
+## Dependencies
+
+- nodejs https://nodejs.org/en/ (v10)
+- Kafka (v2)
+- Mongodb (v4)
+
+## Configuration
+
+Configuration for the application is at `config/default.js`.
+The following parameters can be set in config files or in env variables:
+
+- LOG_LEVEL: the log level
+- PORT: the server port
+- MONGODB_URL: Mongo DB URL
+
+## Local deployment
+
+- From the project root directory, run the following command to install the dependencies
+
+```bash
+npm i
+```
+
+- To run linters if required
+
+```bash
+npm run lint
+
+npm run lint:fix # To fix possible lint errors
+```
+
+- Start the express server
+
+```bash
+npm start
+```
+
+## Heroku Deployment
+
+- git init
+- git add .
+- git commit -m init
+- heroku create
+- heroku config:set MONGODB_URL=...
+- git push heroku master
+
+## Verification
+
+- Import the collection and environment into your POSTMAN app and check out the endpoints

docs/Leaderboard API.postman_collection.json

@@ -0,0 +1,83 @@
+{
+	"info": {
+		"_postman_id": "6ded693a-4eab-49d0-ac45-49621336658e",
+		"name": "Leaderboard API",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "Get leaderboard with challengeId",
+			"request": {
+				"method": "GET",
+				"header": [],
+				"body": {},
+				"url": {
+					"raw": "{{URL}}/leaderboard?challengeId=30051825",
+					"host": [
+						"{{URL}}"
+					],
+					"path": [
+						"leaderboard"
+					],
+					"query": [
+						{
+							"key": "challengeId",
+							"value": "30051825"
+						}
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Get leaderboard with skip and limit",
+			"request": {
+				"method": "GET",
+				"header": [],
+				"body": {},
+				"url": {
+					"raw": "{{URL}}/leaderboard?challengeId=30051825&skip=1&limit=2",
+					"host": [
+						"{{URL}}"
+					],
+					"path": [
+						"leaderboard"
+					],
+					"query": [
+						{
+							"key": "challengeId",
+							"value": "30051825"
+						},
+						{
+							"key": "skip",
+							"value": "1"
+						},
+						{
+							"key": "limit",
+							"value": "2"
+						}
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Get leaderboard without challengeId",
+			"request": {
+				"method": "GET",
+				"header": [],
+				"body": {},
+				"url": {
+					"raw": "{{URL}}/leaderboard",
+					"host": [
+						"{{URL}}"
+					],
+					"path": [
+						"leaderboard"
+					]
+				}
+			},
+			"response": []
+		}
+	]
+}

docs/leaderboard-api.postman_environment.json

@@ -0,0 +1,16 @@
+{
+  "id": "550a699a-87d8-4799-99a2-b9f22980f415",
+  "name": "leaderboard-api",
+  "values": [
+    {
+      "key": "URL",
+      "value": "http://localhost:3000",
+      "description": "",
+      "type": "text",
+      "enabled": true
+    }
+  ],
+  "_postman_variable_scope": "environment",
+  "_postman_exported_at": "2018-10-15T07:56:51.910Z",
+  "_postman_exported_using": "Postman/6.1.3"
+}