https://github.com/struckchure/pay-off-api

https://github.com/struckchure/pay-off-api

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/struckchure/pay-off-api
• Owner: struckchure
• Created: 2023-06-07T21:44:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-29T13:04:56.000Z (over 1 year ago)
• Last Synced: 2024-10-07T19:45:57.854Z (29 days ago)
• Language: TypeScript
• Size: 344 KB
• Stars: 16
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## PayOff API

The API utilizing biometrics for payout and transfer authorization enhances security and user experience by verifying unique physical or behavioral traits. Users initiate transactions, provide biometric data (e.g., fingerprints), which is verified against stored templates. Successful verification authorizes the transaction, ensuring only authorized individuals can complete payouts or transfers. This biometric authentication adds a secure layer and streamlines the user experience, reducing reliance on traditional authentication methods. Compliance with privacy regulations is crucial to protect sensitive biometric information.

## Installation

```bash

$ yarn

```

## Setup Postgres and Localstack S3

```bash

$ docker compose up --force-recreate -d

$ docker compose exec localstack awslocal s3api create-bucket --bucket payoff

```

## Running the app

```bash

# development

$ yarn start

# watch mode

$ yarn start:dev

# production mode

$ yarn start:prod

```

## Test

```bash

# unit tests

$ yarn test

# e2e tests

$ yarn test:e2e

# test coverage

$ yarn test:cov

```