phixius-nacha-csp-service-api v0.0.1-security

• Nacha-CSP
  • Prerequisites
  • Getting Started
    • Partner Services
    • Documentation
  • Configuration
    • Setting Configuration With A Config File
    • Setting Configuration With Environment Variables
    • Overriding Configuration for Local Development

Nacha-CSP

Prerequisites

1. Install Docker for Mac, or Docker for Windows

2. Install and start dotdocker

dotdocker start

1. This project is private and also depends on other private packages hosted on EYBlockchain's private npm registry. In order to use it, first follow the developer instructions here to configure npm.

2. You need to login to docker in order to be able to pull these images from ACR. Please first run the following: docker login phixiuspreprod.azurecr.io -u phixiuspreprod

Note: It will prompt you to enter a password. Please reach out to a team lead for the password.

Getting Started

1. Clone this repository to your computer: git clone git@github.com:nacha-phixius/phixius-nacha-csp-service-api.git
2. Run:

cd phixius-nacha-csp-service-api
docker-compose up -d

When docker is done building, the API will be available at http://nacha-csp.phixius.docker.

Configuration

node-config is being used in order to manage config values by mounting in a deafult.json5 file into the /app/config directory, or by setting environment values.

The following configuration is available.

Setting Configuration With A Config File

Create a config file in your project, i.e. ./config/default.json5:

{
  "offchainDbUrl": "postgres://postgres:postgres@127.0.0.1/postgres",
  "logLevel": "dev",
  "azureAppInsightsIKey":"699f7060-48a5-*****-**********"
}

Then you need to mount that file into the /app/config/ directory. Make sure to name it default.json5 inside the container, as node-config will automatically load this file and merge it with the default configuration.

Overriding Configuration for Local Development

In order to override config values for local development without having to worry about committing those changes, you can create a ./config/local.json5.