# revops-js

> Official RevOps Javascript Component Library

Latest version **1.0.0-beta32** (published 2022-02-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install revops-js
pnpm add revops-js
yarn add revops-js
bun add revops-js
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.0-beta32 |
| Published | 2022-02-12 |
| First published | 2019-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 3.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | RevOps |
| Maintainers | adam-revops, john-revops |

## Links

- npm: https://www.npmjs.com/package/revops-js
- Repository: https://github.com/revops-io/revops.js
- Homepage: https://github.com/revops-io/revops.js#readme
- Issues: https://github.com/revops-io/revops.js/issues
- npm.io page: https://npm.io/package/revops-js

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.17.2
- [react-plaid-link](https://npm.io/package/react-plaid-link.md) ^3.3.0
- [babel-plugin-transform-runtime](https://npm.io/package/babel-plugin-transform-runtime.md) ^6.23.0
- [@babel/plugin-proposal-class-properties](https://npm.io/package/@babel/plugin-proposal-class-properties.md) ^7.16.7

## Recent versions

- 1.0.0-beta32 (latest) — 2022-02-12
- 1.0.0-beta31 (revops-js@1.0.0-beta31) — 2022-02-12
- 1.0.0-beta23 (promisfy-beta) — 2020-01-28
- 1.0.0-beta15 (beta) — 2019-11-13
- 1.0.0-beta30 — 2022-02-12
- 1.0.0-beta29 — 2021-05-06
- 1.0.0-beta28 — 2021-04-01
- 1.0.0-beta27 — 2021-03-08
- 1.0.0-beta26 — 2020-06-05
- 1.0.0-beta25 — 2020-04-06
- 1.0.0-beta24 — 2020-02-27
- 1.0.0-beta22 — 2019-12-18
- 1.0.0-beta21 — 2019-12-08
- 1.0.0-beta20 — 2019-12-07
- 1.0.0-beta19 — 2019-12-05
- … 18 more at https://npm.io/package/revops-js/versions

## README

# revops-js

> Official RevOps Javascript Component Library

[![Build Status](https://travis-ci.org/revops-io/revops.js.svg?branch=master)](https://travis-ci.org/revops-io/revops.js) [![NPM](https://img.shields.io/npm/v/revops-js.svg)](https://www.npmjs.com/package/revops-js) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

RevOps helps software businesses set up their usage-based pricing and billing. Request early access at https://www.revops.io and automate your pricing today.

## Usage

### Build a payment portal to create and manage customers with a few lines of code.
Here we use the public API key found in RevOps at `https://<your-organization>.revops.io/integrations/api/key`. 
For more information on authentication see [Authentication Overview](https://github.com/revops-io/revops.js/wiki/Authentication-Overview).

```jsx
import React from 'react'

import { PaymentMethod } from 'revops-js'

/* Default stylesheet to configure the look and feel */
import 'revops-js/themes/defaultStyles.css'


export const App = ({ 
  accountId = 'your-acct-id', 
  publicKey = 'your-public-api-key' 
}) => (
  <PaymentMethod
    publicKey={publicKey}
    account={{
      accountId: accountId,
      email: 'bugs@bunny.com',
    }}
  />
)

export default App
```

See a live example and play with a demo at https://codesandbox.io/s/sample-revopsjs-form-tx6kv

It only takes a few steps:

1. Copy your public API key from `https://<your_instance>.revops.io/integrations/api/key`
2. Replace the __public key__
3. Complete the form
4. Find the account at `https://<your_instance>.revops.io/accounts`

## Main Components
- [SignUp](https://github.com/revops-io/revops.js/wiki/SignUp) - Creates an acccount in RevOps
- [PaymentMethod](https://github.com/revops-io/revops.js/wiki/Payment-Method) - Creates and modifies payment instruments. Also supports the creation of accounts in RevOps for a unified workflow.
- [RevOpsAuth](https://github.com/revops-io/revops.js/wiki/RevOpsAuth-Component) - Wrapper component used to authenticate and coordinate state between multiple components. 

## Integrating Revops-js
Revops-js is highly customizable and supports a number of ways to integrate it into an existing application.
- [PaymentMethod Integration Guide](https://github.com/revops-io/revops.js/wiki/Guide-to-Integrating-PaymentMethod-Components)
- [Styling Revops-js Components](https://github.com/revops-io/revops.js/wiki/Styling-Revops-js-Components)
- [Authentication Overview](https://github.com/revops-io/revops.js/wiki/Authentication-Overview)
- [Using Callbacks](https://github.com/revops-io/revops.js/wiki/Using-Callbacks-to-Integrate-Revops-js)
- [Using Refs](https://github.com/revops-io/revops.js/wiki/Using-Refs-with-Revops-js)
- [Logging Levels](https://github.com/revops-io/revops.js/wiki/Logging-Levels)

## API Documentation
- [Accounts](https://www.revops.io/docs/rest-api/accounts)
- [Instruments](https://www.revops.io/docs/rest-api/instruments)


## License

MIT © [RevOps, Inc.](https://revops.io)

---
_Source: https://npm.io/package/revops-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._