config updates

Signed-off-by: Arnav Gupta <arnav@codingblocks.com>

Author: championswimmer

.idea/codeStyles/Project.xml

@@ -28,3 +28,17 @@ If using a fresh db, seed the languages before testing
 npm run build
 npm run seedlangs
 ```
+
+
+## Requirements
+
+### Database (Postgres)
+We need a PostgreSQL database to run. Please configure the following env variables -
+
+```env
+    DB_NAME='judgeapi',
+    DB_USER='judgeapi',
+    DB_PASS='judgeapi',
+    DB_HOST='localhost'
+```
+### Queue (RabbitMQ)

README.md

@@ -2,14 +2,22 @@ exports = module.exports = {
   RUN: {
     TIMEOUT: process.env.RUN_TIMEOUT || 10000,
   },
+
+  // Domain/Host on which judge-api is hosted
   HOST: process.env.JUDGEAPI_HOST || 'localhost',
+  // Port on which this app will run
   PORT: process.env.JUDGEAPI_PORT || 3737,
+
+  // Database config for a postgresql db (docker based or native)
   DB: {
     DATABASE: process.env.DB_NAME || 'judgeapi',
     USERNAME: process.env.DB_USER|| 'judgeapi',
     PASSWORD: process.env.DB_PASS|| 'judgeapi',
     HOST: process.env.DB_HOST || 'localhost'
   },
+
+  // Rabbit MQ queue - the other end of which is attached
+  // to judge-taskmaster
   AMQP: {
     USER: process.env.AMQP_USER || 'codingblocks',
     PASS: process.env.AMQP_PASS || 'codingblocks',