piixpay-express-middleware
v1.4.3
Published
piixpay.com receive payments API express middleware
Downloads
6
Readme
Piixpay.com payments API express middleware
Express middleware for receiving payments using piixpay.com.
- Provides a working example express server application.
- Provides QR code rendering.
- Provides express middleware that handles the callbacks.
- Written in TypeScript, no need for extra typings.
- Supports creating invoices, getting invoice info, getting rates.
Installation
This package is distributed via npm
npm install piixpay-express-middleware
Configuration
The example application requires API key.
To set these, create a ".env" file in the project root directory with contents like:
SERVER_HOST=example.com
SERVER_PORT=3000
SERVER_USE_SSL=false
SERVER_CERT=fullchain.pem
SERVER_KEY=privkey.pem
API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Commands
yarn start
to start the example application.yarn build
to build the production version.yarn test
to run tests.yarn coverage
to gather code coverage.yarn lint
to lint the codebase.yarn prettier
to run prettier.yarn audit
to run all pre-commit checks (prettier, build, lint, test)