# smallfire > Very small Firebase Javascript client Latest version **1.0.1** (published 2021-05-21) · MIT license · 0 weekly downloads ## Install ```sh npm install smallfire pnpm add smallfire yarn add smallfire bun add smallfire ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2021-05-21 | | First published | 2021-05-21 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 59.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Alan Bird | | Maintainers | alanlbird | ## Links - npm: https://www.npmjs.com/package/smallfire - npm.io page: https://npm.io/package/smallfire ## Recent versions - 1.0.1 (latest) — 2021-05-21 - 1.0.0 — 2021-05-21 ## README # SmallFire SmallFire is a Javascript client for accessing Firestore and Firebase realtime databases. It is a much smaller replacement for the the basic functionality of the official Firebase SDK libraries. Compare sizes below: Library | Firebase SDK | SmallFire --- | ---: | ---: Firebase core | 7 KB | Auth | 56 KB | 0.7 KB Firestore | 90 KB | 2.9 KB Firebase RTDB | 51 KB | 1.0 KB Full Library | 204 KB | 3.9 KB
If you are developing a light-weight web app that uses Firestore and or Firebase realtime database, this can greatly reduce the size of your downloads resulting in faster app startup. There are three library modules that can be loaded separately: `auth`, `firestore`, and `firebase`. Or, you can load the combined bundle: `smallfire`. The `auth` module supports only email/password authentication and is only necessary when dealing with non-public data.
#### **Firebase SDK 9 Beta Note** Google has recently released Firebase SDK 9 Beta, which uses a modular approach that has the potential to reduce the size of the SDK. It's difficult to measure the size of the SDK with this version, but our initial testing indicates that when loading the three modules `auth`, `firestore`, and `firebase`, the overal SDK is still above 100 KB. ## **Firestore Features** These features are supported with the `firestore` module for the Firestore database: Feature | Description ------------ | ------------- `get` | get a single document `list` | list some or all documents in a collection `set` | replace the value of a document or create a new one `update` | update fields in a document `delete` | delete a document `query` | get documents based on a query `listen` | get a document and listen for realtime updates
## **Firebase Realtime Database Features** These features are supported with the `firebase` module for the Firebase realtime database: Feature | Description ------------ | ------------- `get` | read data `set` | write data replacing existing data `update` | write data merging with existing data `push` | add to list with a unique key `delete` | delete data `listen` | read data and get realtime updates
## Installation ### **Script Tag** The simplest way to add SmallFire to your web app is to add the following script tag to your `` or `` section: ``` ``` You can also add modules individually: ``` ``` Then access the SmallFire functions using the `smallfire` global variable: ``` javascript smallfire.auth.currentUser() smallfire.auth.signIn() smallfire.auth.signOut() smallfire.getFirestoreDB() smallfire.getFirebaseDB() ``` or ``` javascript const { auth, getFirestoreDB, getFirebaseDB } = window ```
### **Node** If you are using a Node build environment such as with Javascript libraries React or Vue, install SmallFire from NPM: ``` npm install smallfire ``` Then import the SmallFire functions: ``` javascript import { auth, getFirestoreDB, getFirebaseDB } from smallfire/smallfire ``` or import separately: ``` javascript import { auth } from smallfire/auth import { getFirebaseDB } from smallfire/firebase import { getFirestoreDB } from smallfire/firestore ```
## Documentation Please see individual module documentation: * [Authentication](https://github.com/abird/smallfire/blob/master/docs/auth.md) * [Firebase realtime database](https://github.com/abird/smallfire/blob/master/docs/firebase.md) * [Firestore database](https://github.com/abird/smallfire/blob/master/docs/firestore.md) --- _Source: https://npm.io/package/smallfire · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._