Payments Common Component

Scope Of Project

TBD

Technical Setup

Prerequisites:

• Docker
• Docker Compose
• Python 3 & pip
• AWS Cli V2 - (https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
• Localstack awslocal https://docs.localstack.cloud/integrations/aws-cli/#localstack-aws-cli-awslocal
• Cyberduck - To browse s3 files

Yarn Workspaces Setup

This project is setup using yarn workspaces for the lambda functions.

Yarn V2 is the latest version.

Yarn V2 needs to be enabled in node js versions 16 and above - Follow these steps to get yarn setup locally - https://yarnpkg.com/getting-started/install

Environment Variables

Create a .env file at the root prior to running the project

• PCC_SFTP=
• BCM_SFTP=
• DB_HOST=
• DB_NAME=
• DB_USER=
• DB_PASSWORD=
• DB_ROOT_PASSWORD=
• DB_PORT=
• AWS_ACCESS_KEY_ID=
• AWS_SECRET_ACCESS_KEY=
• AWS_DEFAULT_REGION=

Running The Project Locally (Docker)

Build docker containers: make build-local Run docker containers: make run-local Close docker containers: make close-local Local api logs: make local-backend-logs

SFTP files and scripts to fill the database

• Add BCM_SFTP and PCC_SFTP in a root .env

• Ensure you are connected to the cisco VPN

• Ensure you are connected to Localstack/Cyber Duck

• For the env vars reach out to anyone on the team, the format is: 'sftp://@'

• Run make get-daily-recon-files

• Check that your cyber duck/ local stack has the files

• Run make add-data to populate the db