# userbase-js

> Userbase JS browser SDK

Latest version **2.8.0** (published 2021-02-09) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.8.0 |
| Published | 2021-02-09 |
| First published | 2019-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2338 |
| Maintainers | dvassallo, j-berman |
| Keywords | database, userbase, userbase SDK, encryption, end-to-end encryption, js client, authentication |

## Links

- npm: https://www.npmjs.com/package/userbase-js
- Repository: https://github.com/smallbets/userbase
- Issues: https://github.com/smallbets/userbase/issues
- npm.io page: https://npm.io/package/userbase-js

## Dependencies (6)

- [uuid](https://npm.io/package/uuid.md) ^3.4.0
- [scrypt-js](https://npm.io/package/scrypt-js.md) ^3.0.0
- [sorted-array](https://npm.io/package/sorted-array.md) ^2.0.4
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.9.2
- [diffie-hellman](https://npm.io/package/diffie-hellman.md) ^5.0.3
- [base64-arraybuffer](https://npm.io/package/base64-arraybuffer.md) ^0.2.0

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 2.8.0 (latest) — 2021-02-09
- 2.7.4 — 2021-02-06
- 2.7.3 — 2021-01-18
- 2.7.2 — 2021-01-18
- 2.7.1 — 2021-01-13
- 2.7.0 — 2020-12-31
- 2.6.0 — 2020-12-17
- 2.5.0 — 2020-12-09
- 2.4.3 — 2020-12-03
- 2.4.2 — 2020-12-02
- 2.4.1 — 2020-11-30
- 2.4.0 — 2020-11-24
- 2.3.0 — 2020-10-26
- 2.2.2 — 2020-10-08
- 2.2.1 — 2020-09-10
- … 30 more at https://npm.io/package/userbase-js/versions

## README

# Userbase: Create secure and private web apps using only static JavaScript, HTML, and CSS.

## What is Userbase?

Userbase is the easiest way to add user accounts and user data persistence to your static site. All Userbase features are accessible through a very simple [JavaScript SDK](https://userbase.com/docs/sdk/), directly from the browser. No backend necessary.

### Built-in user accounts
Userbase takes care of your user accounts. The Userbase SDK lets you sign up, login, and logout users directly from your static site.

### Zero-management database
Instead of sending database queries to a server, Userbase sends the user's data to the browser. Queries happen client-side, and there is nothing on the backend to manage or worry about.

### End-to-end encryption
Userbase encrypts all database operations in the browser with user-controlled keys. This helps you prevent personal data misuse, and lets you offer a high level of data privacy.

### Open source
Userbase is [100% open source](https://github.com/encrypted-dev/userbase), MIT licensed. You can host it yourself always under your control, or [we can run it for you](https://userbase.com/pricing/) for a full serverless experience.

## When would I use it?
If you're building a web app, you will likely need a database and a backend. Userbase can replace both of those things...

- If you want to build a web app without writing any backend code.
- If you want secure authentication out of the box.
- If you want to store user data securely.
- If you want to radically simplify your GDPR compliance.
- And if you want to keep things really simple.

Check out the [FAQ](https://userbase.com/docs/faq/) for more details.

## How do I start?
The easiest way to start using Userbase is to create a [free Admin account](https://userbase.com) and follow the [Quickstart](https://userbase.com/docs/quickstart/) guide. If you have any questions, or if there's anything we can do to help you with your web app, please [get in touch](https://userbase.com/contact/). Thank you!

## Browser Compatibility

We have tested support for the following browsers:

- Chrome >= 78
- Safari >= 11
- Firefox >= 71
- Chrome Android >= 80
- Safari iOS >= 13

To support Internet Explorer, you will need to use a Promise polyfill such as [this one](https://github.com/taylorhakes/promise-polyfill).

## Credits
The people who made this project a reality:
- [Daniel Vassallo](https://twitter.com/dvassallo)
- [Justin Berman](https://twitter.com/justinberman95)
- [Luca Cipriani](https://twitter.com/mastrolinux)
- [Tony D'Addeo](https://twitter.com/amdaddeo)

## License

This project is released under the [MIT License](https://github.com/encrypted-dev/userbase/blob/master/LICENSE).

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