documentation updates

Author: ThomasKranitsas

README.md

@@ -115,6 +115,84 @@ This script will load the data from `scripts/data` directory into ES
 npm run start
 ```
 
+### Local Deployment
+0. Make sure to use Node v10+ by command `node -v`. We recommend using [NVM](https://github.com/nvm-sh/nvm) to quickly switch to the right version:
+
+   ```bash
+   nvm use
+   ```
+
+1. 📦 Install npm dependencies
+
+   ```bash
+   npm install
+   ```
+
+2. ⚙ Local config   
+   In the `submissions-api` root directory create `.env` file with the next environment variables. Values for **Auth0 config** should be shared with you on the forum.<br>
+     ```bash
+     # AWS related config
+     AWS_ACCESS_KEY_ID=
+     AWS_SECRET_ACCESS_KEY=
+     AWS_REGION=
+     S3_BUCKET=
+     ARTIFACT_BUCKET=
+
+     # Auth0 config
+     AUTH0_URL=
+     AUTH0_PROXY_SERVER_URL=
+     TOKEN_CACHE_TIME=
+     AUTH0_AUDIENCE=
+     AUTH0_CLIENT_ID=
+     AUTH0_CLIENT_SECRET=
+
+     # Locally deployed services (via docker-compose)
+     ES_HOST=localhost:9200
+     ```
+
+   - Values from this file would be automatically used by many `npm` commands.
+   - ⚠️ Never commit this file or its copy to the repository!
+
+3. 🚢 Start docker-compose with services which are required to start Topcoder Submissions API locally
+
+   ```bash
+   npm run services:up
+   ```
+   - `npm run services:down` can be used to shutdown the docker services
+   - `npm run services:logs` can be used to view the logs from the docker services
+
+4. ♻ Create tables.
+
+   ```bash
+   npm run create-tables
+   ```
+5. ♻ Create ES index.
+
+   ```bash
+   npm run create-index
+   ```
+
+6. ♻ Init DB, ES
+
+   ```bash
+   npm run local:init
+   ```
+
+   This command will do 2 things:
+   - Import the data to the database and index it to ElasticSearch
+   - Note, to migrate the existing data from DynamoDB to ES, run the following script
+      ```
+      npm run db-to-es
+      ```
+
+7. 🚀 Start Topcoder Submissions API
+
+   ```bash
+   npm run start
+   ```
+   The Topcoder Submissions API will be served on `http://localhost:3000`
+
+
 #### Linting JS files
 
 ```

config/default.js

@@ -1,7 +1,7 @@
 /**
  * Default configuration file
  */
-
+require('dotenv').config()
 module.exports = {
   DISABLE_LOGGING: process.env.DISABLE_LOGGING || false, // If true, logging will be disabled
   LOG_LEVEL: process.env.LOG_LEVEL || 'debug',

local/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3'
+services:
+  esearch:
+    image: "docker.elastic.co/elasticsearch/elasticsearch:6.8.0"
+    ports:
+      - "9200:9200"
+    environment:
+      - "discovery.type=single-node"

package.json

@@ -19,7 +19,11 @@
     "test": "mocha test/unit/*.test.js --require test/unit/prepare.js --exit",
     "e2e": "mocha test/e2e/*.test.js --require test/e2e/prepare.js --exit",
     "cov": "nyc --reporter=html --reporter=text mocha test/unit/*.test.js --require test/unit/prepare.js --exit",
-    "cov-e2e": "nyc --reporter=html --reporter=text mocha test/e2e/*.test.js --require test/e2e/prepare.js --exit"
+    "cov-e2e": "nyc --reporter=html --reporter=text mocha test/e2e/*.test.js --require test/e2e/prepare.js --exit",
+    "services:up": "docker-compose -f ./local/docker-compose.yml up -d",
+    "services:down": "docker-compose -f ./local/docker-compose.yml down",
+    "services:logs": "docker-compose -f ./local/docker-compose.yml logs",
+    "local:init": "npm run init-db && npm run init-es"
   },
   "dependencies": {
     "amazon-s3-uri": "0.0.3",
@@ -30,6 +34,7 @@
     "common-errors": "^1.0.4",
     "config": "^1.26.2",
     "cors": "^2.8.4",
+    "dotenv": "^8.2.0",
     "elasticsearch": "^15.1.1",
     "express": "^4.15.4",
     "express-fileupload": "^0.4.0",