Skip to content

erayerdin/firereact

Repository files navigation

Firereact

This project is a 3rd-party project and is not affiliated or endorsed by React or Firebase and their owners, Alphabet and Meta.

NPM Version NPM Downloads NPM License GitHub Actions Workflow Status Codecov npm bundle size npm minzipped size Read the Docs

Firereact is hooks, component and utilities library for Firebase and React.

Installation

You can install the package via NPM:

npm i firereact

Features

  • Very lightweight, unpacked size when unpacked, npm min bundle size when minified, npm minzip bundle size when minified+gzipped
  • Supports Javascript and Typescript
  • Supports Auth, Firestore, Functions, Providers and Storage.
  • Provides hooks such as useUser for Auth or useDocument for Firestore, which can listen to realtime changes as well
  • Provides custom components such as <FirestoreDocument /> or <StorageDownloadLink /> to keep the logic simple and/or avoid unnecessary rerendering
  • Provides Providers such as FirebaseSuiteProvider, FirebaseAuthProvider or FirestoreProvider to access Firebase service instances anywhere in the component tree without relying on global variables or prop-drilling
  • Comprehensive documentation

Documentation

To use this library, check out the documentation here.

Contributing

You are welcome to contribute to the project. Before contributing:

  • Always send pull requests to dev branch, which is the default branch of this repository. main branch is used for latest published version.
  • You agree our code of conduct.

License

This library is licensed under MIT License.