Web subscriptions made easy. Powered by RevenueCat
npm install @revenuecat/purchases-jsRevenueCat is a powerful, reliable, and free to use in-app purchase server with cross-platform support.
This repository includes all you need to manage your subscriptions on your website or web app using RevenueCat.
Sign up to get started for free.
Login @ app.revenuecat.com
- Connect your Stripe account if you haven't already (More payment gateways are coming soon)
- Create a Project (if you haven't already)
- Add a new Web Billing app
- Get the sandbox API key or production API key (depending on the environment)
- Create some products for the Web Billing App
- Create an offering and add packages with Web Billing products
- Create the entitlements you need in your app and link them to the Web Billing products
- Add the library to your project's dependencies
- npm
```
npm install --save @revenuecat/purchases-js
`
- yarn
`
yarn add --save @revenuecat/purchases-js
See the RevenueCat docs and the SDK Reference.
- Clone the repository
- Install dependencies
- Build the library
`bash`
pnpm install
pnpm run build:dev
To avoid publishing the package you can use Yarn's link feature:
1. In the purchases-js directory, register the package:
`bash`
yarn link
2. In your testing project, link to the registered package:
`bash`
yarn link "@revenuecat/purchases-js"
> Note: Any changes you make to the library will be automatically reflected in your testing project after running pnpm run build:dev or pnpm run build.
`bash`
pnpm run storybook
> Note: This setup is only required if you need to test Storybook stories involving the payment-entry page.
To run these specific stories, you'll need to set up some environment variables. There are two options:
Internal team members can find the required environment variables in 1Password.
1. Create a test account in Stripe
2. Create a .env.development.local file and set the following variables:
`bash`
VITE_STORYBOOK_PUBLISHABLE_API_KEY="pk_test_1234567890"
VITE_STORYBOOK_ACCOUNT_ID="acct_1234567890"
`bash`
pnpm run test
`bash`
pnpm run test:typecheck
pnpm run svelte-check
pnpm run prettier
pnpm run lint
Please check the Demo app readme here
`bash`
pnpm run extract-api
This will update the files in api-report with the latest public API.
If it has uncommitted changes, CI tests will fail. Run this command and commit the changes if
they are expected.
New versions are automated weekly, but you can also trigger a new release through CircleCI or locally
following these steps:
- Run bundle exec fastlane bump` and follow the instructions
- A PR should be created with the changes and a hold job in CircleCI.
- Approve the hold job once tests pass. This will create a tag and continue the release in CircleCI
- Merge the PR once it's been released