/Trogs-Backend

Backend repository for Trogs application for Oktane Hackathon.

Primary LanguageJavaScript

Trogs-Backend

Backend repository for Trogs application for Oktane Hackathon.

How to setup ?

  1. Clone this repo.
  2. Download config.js into the cloned Backend folder from here
  3. Download config.ini into the cloned Worker folder from here
  4. Download config.env into the cloned DockerDBSetup folder from here.
  5. Run
  $ docker network create trogsNetwork
  1. Then cd into DockerDBSetup folder and run docker-compose up
  2. Then open a new terminal and cd back into the main folder and again run docker-compose up.
  3. Setup Complete 👍

Usage:

Currently API's are not documented but you can see their example usage in test.sh file.

Overview

  • From frontend an accessToken will be sent in Header of each request, then Authorization handler middleware as defined in auth.js file check if the request is valid and put the JWT of the user as returned by Okta in to req.jwt and similarly for email and uid.
  • We will be identifying a user by it's unique uid in our database.
.

Without Frontend

  • To test the backend API's we need a valid accessToken, to do that open the accessToken.html by creating a server in python by following these steps (first ensure either you are logged out of all Okta services or either perform the browser steps in Incognito Mode):
  1. On terminal run (from python2), run this in the folder containing the code:
$ python -m SimpleHTTPServer

  1. Now open http://localhost:8000 in Incognito and open accessToken.html with Console of Browser open.

  2. Log into your Okta account, after logging in the accessToken will be logged in console. Copy that token and place it in accessToken variable in test.sh file.

  3. Install httpie on your system.

  4. Then you can manipulate test.sh to test different API's by changing the url and type of request. You can read the docs of httpie for help.

Response on /api/v1/users/

{
    "friends": [],
    "logs": [
        {
            "amount": 1000,
            "boolPersonal": false,
            "category": "Personal",
            "completeLog": "Message for testing hey are you there this is agin done.",
            "msgRefId": "123456789",
            "secUsername": "",
            "title": "Testing log title: Messag",
            "uniqueRefId": "07f784ae0abc5048d4c53aa38591687f8d268bdd1007a60bfab9ba59"
        }
    ],
    "thumbnailUrl": "https://www.gravatar.com/avatar/6a10c16fdcb96765e4ebf1a483e31360?d=robohash",
    "username": "vaibhav.thakkar.22.12.99@gmail.com"
}

TODO

=> Implement search API.
=> Deploy.
=> Define function for data extraction from SMS in python.