Implement api

Author: callmekatootie

.dockerignore

@@ -0,0 +1,6 @@
+node_modules
+.idea
+**/.DS_Store
+docs
+.env
+coverage

.gitignore

@@ -1,104 +1,8 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
+node_modules
+.idea
+**/.DS_Store
+upload
+scripts/generate
 .nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
 .env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
+coverage

.swagger-codegen-ignore

@@ -1,23 +1,48 @@
-# Swagger generated server
-
-# u-bahn-search-ui-api
-Universal Identity Search UI API
-
-
-## Overview
-This server was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.  By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub.
-
-### Running the server
-To run the server, run:
-
-```
-npm start
-```
-
-To view the Swagger UI interface:
-
-```
-open http://localhost:8080/docs
-```
-
-This project leverages the mega-awesome [swagger-tools](https://github.com/apigee-127/swagger-tools) middleware which does most all the work.
+# UBahn Search UI API
+
+## Install software
+
+- node 12.x
+- npm 6.x
+- docker
+- S3
+
+## Local database deployment
+
+1. Navigate to docker-db run `docker-compose up -d`
+2. Follow *Configuration* section to update config values
+3. Run `npm i` and `npm run lint`
+4. Create table, `npm run create-tables`, this will create tables (if you need this)
+5. Startup server `npm run start`
+
+## Configuration
+
+Configuration for the application is at `config/default.js` and `config/production.js`. The following parameters can be set in config files or in env variables:
+
+- LOG_LEVEL: the log level
+- PORT: the server port
+- API_VERSION: the API version
+- AUTH_SECRET: TC Authentication secret
+- VALID_ISSUERS: valid issuers for TC authentication
+- AMAZON.AWS_REGION: The Amazon region to use when connecting. For local dynamodb you can set fake value.
+- AMAZON.IS_LOCAL_DB: Use local or AWS Amazon DynamoDB
+- AMAZON.DYNAMODB_URL: The local url, if using local Amazon DynamoDB
+- AMAZON.DYNAMODB_READ_CAPACITY_UNITS: the AWS DynamoDB read capacity units, if using local Amazon DynamoDB
+- AMAZON.DYNAMODB_WRITE_CAPACITY_UNITS: the AWS DynamoDB write capacity units, if using local Amazon DynamoDB
+- AMAZON.DYNAMODB_UPLOAD_TABLE: DynamoDB table name for upload
+- AMAZON.DYNAMODB_TEMPLATE_TABLE: DynamoDB table name for template
+- AUTH0_URL: Auth0 URL, used to get TC M2M token
+- AUTH0_AUDIENCE: Auth0 audience, used to get TC M2M token
+- TOKEN_CACHE_TIME: Auth0 token cache time, used to get TC M2M token
+- AUTH0_CLIENT_ID: Auth0 client id, used to get TC M2M token
+- AUTH0_CLIENT_SECRET: Auth0 client secret, used to get TC M2M token
+- AUTH0_PROXY_SERVER_URL: Proxy Auth0 URL, used to get TC M2M token
+- BUSAPI_URL: the bus api, default value is `https://api.topcoder-dev.com/v5`
+- KAFKA_ERROR_TOPIC: Kafka error topic, default value is 'common.error.reporting'
+- KAFKA_MESSAGE_ORIGINATOR: the Kafka message originator, default value is 'ubahn-search-ui-api'
+- UPLOAD_CREATE_TOPIC: the upload create Kafka topic, default value is 'ubahn.action.create'
+- TEMPLATE_FILE_MAX_SIZE: the template file restrict size, default value is '2MB'
+- TEMPLATE_FILE_MIMETYPE: the template file accept type, default value is 'application/vnd.ms-excel,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+- TEMPLATE_S3_BUCKET: the template s3 bucket name, default value is 'ubahn'
+- UPLOAD_S3_BUCKET: the upload s3 bucket name, default value is 'ubahn'
+- S3_OBJECT_URL_EXPIRY_TIME: the s3 url expiry time, default value is '1 hour'