miscellaneous

Author: callmekatootie

README.md

@@ -62,12 +62,12 @@ Setup your Elasticsearch instance and ensure that it is up and running.
 
 1. Follow *Configuration* section to update config values, like database, etc ..
 2. Goto *UBahn-api*, run `npm i` and `npm run lint`
-3. Import mock data, `node scripts/db/genData.js`, this will gen some data for test (if you need this)
+3. Run the migrations - `npm run migrations up`. This will create the database, the tables and insert mock data into the database. You will then run `npm run migrate-db-to-es` to migrate the data to elasticsearch from the database
 4. Startup server `node app.js` or `npm run start`
 
-## Working with mock data
+## Migrations
 
-You can use the scripts `npm run migrations up` (and `npm run migrations down`) to insert mock data (and delete mock data respectively). The data is inserted into Postgres and Elasticsearch. You need to setup the configurations beforehand and also start the elasticsearch instance before you run these scripts. You can run the script `npm run migrate-db-to-es` to dump data in db into es.
+Migrations are located under the `./scripts/db/` folder. Run `npm run migrations up` and `npm run migrations down` to execute the migrations or remove the earlier ones
 
 ## Local Deployment with Docker
 
@@ -87,6 +87,4 @@ Make sure all config values are right, and you can run on local successfully, th
 
 5. When you are running the application for the first time, It will take some time initially to download the image and install the dependencies
 
-## Verification
-
-See `Verification.md`
+You can also head into `docker-pgsql-es` folder and run `docker-compose up -d` to have docker instances of pgsql and elasticsearch to use with the api

VERIFICATION.md

@@ -0,0 +1,21 @@
+version: '3'
+services:
+  postgres:
+    image: "postgres:12.4"
+    volumes:
+      - database-data:/var/lib/postgresql/data/
+    ports: 
+      - "5432:5432"
+    environment:
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      POSTGRES_USER: ${DB_USERNAME}
+      POSTGRES_DB: ${DB_NAME}
+  esearch:
+    image: elasticsearch:7.7.1
+    container_name: ubahn-data-processor-es_es
+    ports:
+      - "9200:9200"
+    environment:
+      - discovery.type=single-node
+volumes:
+  database-data:

docker-pgsql-es/docker-compose.yml

@@ -1,23 +1,11 @@
-# TODO - Update BEFORE merge
-
 version: '3'
 services:
-  postgres:
-    image: "postgres:13.1"
-    volumes:
-      - database-data:/var/lib/postgresql/data/
-    ports: 
-      - "5432:5432"
-    environment:
-      POSTGRES_PASSWORD: ${DB_PASSWORD}
-      POSTGRES_USER: ${DB_USERNAME}
-      POSTGRES_DB: ${DB_NAME}
-  esearch:
-    image: elasticsearch:7.7.1
-    container_name: ubahn-data-processor-es_es
+  ubahn_api:
+    image: ubahn_api:latest
+    build:
+      context: ../
+      dockerfile: docker/Dockerfile
+    env_file:
+      - api.env
     ports:
-      - "9200:9200"
-    environment:
-      - discovery.type=single-node
-volumes:
-  database-data:
+      - "3001:3001"

docker/docker-compose.yml

@@ -71,159 +71,12 @@ paths:
         description: "Enrich all child resources under the user"
         required: false
         type: "boolean"
-      - name: "skill[]"
-        in: "query"
-        type: "array"
-        description: "The skill name to filter users with. Specify multiple times to provide multiple values"
-        items:
-          type: "string"
-        collectionFormat: multi
-      - name: "achievement[]"
-        in: "query"
-        type: "array"
-        description: "The achievement name to filter users with. Specify multiple times to provide multiple values"
-        items:
-          type: "string"
-        collectionFormat: multi
-      - name: "location[]"
-        in: "query"
-        type: "array"
-        description: "The location name to filter users with. Specify multiple times to provide multiple values. `location` here is an attribute of the user"
-        items:
-          type: "string"
-        collectionFormat: multi
-      - name: "isAvailable"
-        in: "query"
-        type: "boolean"
-        description: "`true` corresponds to users that are available. `false` corresponds to users that are not available. `isAvailable` here is an attribute of the user"
-        items:
-          type: "string"
-        collectionFormat: multi
-      - name: "orderBy"
-        in: "query"
-        type: "string"
-        description: "Sort order"
-        enum: ["name", "location", "isAvailable"]
       - name: "roleId"
         in: "query"
         description: "Filter by user roleId"
         required: false
         type: "string"
         format: "UUID"
-      - name: "userSkill.skillId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "userSkill.metricValue"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "userSkill.certifierId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "userSkill.certifiedDate"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "skill.skillProviderId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "skill.name"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "skill.externalId"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "skill.uri"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "skillProvider.name"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "userRole.roleId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "role.name"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "externalProfile.organizationId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "externalProfile.uri"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "organization.name"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "achievement.achievementProviderId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "achievement.name"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "achievement.uri"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "achievement.certifierId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "achievement.certifiedDate"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "achievementProvider.name"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "userAttribute.attributeId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "userAttribute.value"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "attribute.attributeGroupId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
-      - name: "attribute.name"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "attributeGroup.name"
-        in: "query"
-        required: false
-        type: "string"
-      - name: "attributeGroup.organizationId"
-        in: "query"
-        required: false
-        type: "string"
-        format: "UUID"
       responses:
         "200":
           description: "OK - the request was successful"

docs/swagger.yaml

@@ -1,5 +1,3 @@
-// TODO - Update BEFORE merge
-
 const _ = require('lodash')
 const sequelize = require('../../src/models/index')
 const dbHelper = require('../../src/common/db-helper')