Merge pull request #45 from iotaledger/42-channel-info-ep

Closes #42, #20, 19 Channel Info Endpoint

README.md

@@ -1 +1,29 @@
 # e-commerce-audit-log
+
+
+## MongoDB
+
+### Setup MongoDB
+
+Start the docker container using: `docker-compose up -d`
+
+Verify it is running: `docker ps`
+
+Expected output:
+
+---
+
+CONTAINER ID   IMAGE          COMMAND                  CREATED         STATUS         PORTS                      NAMES
+
+1a3553ec3f25   mongo:latest   "docker-entrypoint.s…"   5 minutes ago   Up 4 minutes   0.0.0.0:27017->27017/tcp   api_mongodb_container_1
+
+---  
+
+### Connect to MongoDB
+
+Use client like for instance: MongoDB Compass
+
+Coonection String: `mongodb://root:rootpassword@0.0.0.0:27017`
+
+
+

api/.env-example

@@ -0,0 +1,5 @@
+PORT=3000
+IOTA_NODE_URL=https://nodes.thetangle.org:443
+API_VERSION=v1
+DATABASE_URL=mongodb://<USER>:<PASSWORD>@0.0.0.0:27017
+DATABASE_NAME=e-commerce-audit-log

api/.eslintrc.js

@@ -2,5 +2,9 @@ module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint', 'prettier'],
-  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier']
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off'
+  }
 };

api/docker-compose.yml

@@ -0,0 +1,14 @@
+version: '3.7'
+services:
+  mongodb_container:
+    image: mongo:latest
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: root
+      MONGO_INITDB_ROOT_PASSWORD: rootpassword
+    ports:
+      - 27017:27017
+    volumes:
+      - mongodb_data_container:/data/db
+
+volumes:
+  mongodb_data_container: