Installation

FloPay packages are published to npm as private scoped packages under @flopay/*.

1. Authenticate with npm

Add your npm token to your user-level ~/.npmrc (do not commit this file):

//registry.npmjs.org/:_authToken=npm_YOUR_TOKEN_HERE

No special registry routing is needed — @flopay packages are on the default npm registry.

2. Install Packages

# React app (client-side)
npm install @flopay/react @flopay/js
 
# Node.js server
npm install @flopay/node

The @flopay/shared package is a dependency of all other packages and is installed automatically.

CI Setup (GitHub Actions)

Add NPM_TOKEN as a repository or organization secret, then configure your workflow:

- uses: actions/setup-node@v4
  with:
    node-version: 24
    registry-url: 'https://registry.npmjs.org/'
 
- run: npm ci
  env:
    NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

Railway / Vercel / Netlify

Set the NPM_TOKEN environment variable to your npm access token in your hosting provider's dashboard. Most platforms use this automatically for npm authentication.