Skip to content

Latest commit

 

History

History

README.md

NodeJS Quickstart

Introduction

Let's get you started with Truv by walking through this NodeJS Quickstart app. You'll need a set of API keys which you can get by signing up at https://dashboard.truv.com

You'll have two different API keys used by the back end, Client ID and Access key.

Full documentation is available at https://docs.truv.com/docs/quickstart-guide

Requirements

The latest LTS version of nodejs

Set up the NodeJS Quickstart

Once you have your API keys, it's time to run the Truv NodeJS Quickstart app locally.

  1. git clone https://github.com/truvhq/quickstart

  2. cd quickstart

  3. make env

  4. Update the .env file in the root of the project. The contents of the .env has to look like this (values with <> should be replaced by the proper keys or values):

    API_CLIENT_ID=<YOUR CLIENT_ID HERE>
    API_SECRET=<YOUR SECRET KEY MUST BE HERE>
    API_PRODUCT_TYPE=<employment, income, deposit_switch or pll>
    IS_ORDER=<true or false - optional, defaults to true>

    Note: The default flow uses the Orders API for income and employment products, designed for home lending and social services use cases where multiple employer connections are expected. Set IS_ORDER=false for a single connection flow. The deposit_switch and pll products always use the single connection flow.

  5. make node_local

    After running this command, you should see:

    ======================================== ENVIRONMENT ========================================
    {
      API_CLIENT_ID: <YOUR CLIENT ID HERE>,
      API_SECRET: <YOUR SECRET KEY HERE>,
      API_PRODUCT_TYPE: <YOUR PRODUCT TYPE HERE>
    }
    ==============================================================================================
    listening on port 5004
    

    To access the app, open http://127.0.0.1:5004/ in your browser.