Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,28 @@ If the official documentation doesn't help, try starting a [discussion](https://

Yeah, we're definitely not perfect!

Search through [old issues](https://github.com/firebase/reactfire/issues) before submitting a new
Search through [old issues](https://github.com/brokeyourbike/reactfire/issues) before submitting a new
issue as your question may have already been answered.

If your issue appears to be a bug, and hasn't been reported,
[open a new issue](https://github.com/firebase/reactfire/issues/new). Please use the provided bug
[open a new issue](https://github.com/brokeyourbike/reactfire/issues/new). Please use the provided bug
report template and include a minimal repro.

If you are up to the challenge, [submit a pull request](#submit) with a fix!

## <a name="feature"></a>Have a feature request?

Great, we love hearing how we can improve our products! After making sure someone hasn't already
requested the feature in the [existing issues](https://github.com/firebase/reactfire/issues), go
ahead and [open a new issue](https://github.com/firebase/reactfire/issues/new). Feel free to remove
requested the feature in the [existing issues](https://github.com/brokeyourbike/reactfire/issues), go
ahead and [open a new issue](https://github.com/brokeyourbike/reactfire/issues/new). Feel free to remove
the bug report template and instead provide an explanation of your feature request. Provide code
samples if applicable. Try to think about what it will allow you to do that you can't do today? How
will it make current workarounds straightforward? What potential bugs and edge cases does it help to
avoid?

## <a name="submit"></a>Want to submit a pull request?

Sweet, we'd love to accept your contribution! [Open a new pull request](https://github.com/firebase/reactfire/pull/new/master)
Sweet, we'd love to accept your contribution! [Open a new pull request](https://github.com/brokeyourbike/reactfire/pull/new/master)
and fill out the provided form.

**If you want to implement a new feature, please open an issue with a proposal first so that we can
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Have a usage question?
We get lots of those and we love helping you, but GitHub is not the best place for them and they
will be closed. Here are some resources to get help:

- Start with the quickstart: https://github.com/firebase/reactfire/blob/master/docs/quickstart.md
- Go through the guide: https://github.com/firebase/reactfire/blob/master/docs/guide.md
- Read the full API reference: https://github.com/firebase/reactfire/blob/master/docs/reference.md
- Try out some examples: https://github.com/firebase/reactfire/blob/master/examples/README.md
- Start with the quickstart: https://github.com/brokeyourbike/reactfire/blob/master/docs/quickstart.md
- Go through the guide: https://github.com/brokeyourbike/reactfire/blob/master/docs/guide.md
- Read the full API reference: https://github.com/brokeyourbike/reactfire/blob/master/docs/reference.md
- Try out some examples: https://github.com/brokeyourbike/reactfire/blob/master/examples/README.md

If the official documentation doesn't help, try asking through our official support channels:

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ jobs:
name: Build
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v5
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v5
with:
node-version: '18'
node-version: '22'
cache: 'npm'
- name: Install deps
run: npm ci
Expand Down
24 changes: 12 additions & 12 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ jobs:
name: Build
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v5
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v5
with:
node-version: '18'
node-version: '22'
cache: 'npm'
- name: Install deps
run: npm ci
- name: Build
id: pack-dir
run: ./build.sh
- name: 'Upload Artifact'
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: reactfire-${{ github.run_id }}
path: |
Expand All @@ -44,14 +44,14 @@ jobs:
needs: build
strategy:
matrix:
node: ["18", "20"]
node: ["22", "24"]
fail-fast: false
name: Test Node.js ${{ matrix.node }} (Ubuntu)
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v5
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v5
with:
node-version: ${{ matrix.node }}
check-latest: true
Expand All @@ -62,12 +62,12 @@ jobs:
run: npm install
working-directory: ./functions
- name: Firebase emulator cache
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/.cache/firebase/emulators
key: firebase_emulators
- name: 'Download Artifacts'
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
- name: Expand Artifact
run: |
chmod +x reactfire-${{ github.run_id }}/unpack.sh
Expand All @@ -81,12 +81,12 @@ jobs:
if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'release' }}
steps:
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v5
with:
node-version: '18'
node-version: '22'
registry-url: 'https://registry.npmjs.org'
- name: 'Download Artifacts'
uses: actions/download-artifact@v3
uses: actions/download-artifact@v5
- name: Publish
run: |
cd ./reactfire-${{ github.run_id }}/
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
12.11.1
22.12.0
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
The MIT License (MIT)

Copyright (c) 2025 Ivan Stasiuk <ivan@stasi.uk> (stasi.uk)
Copyright (c) 2016 Firebase

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ Firebase.

```bash
# npm
npm install --save firebase reactfire
npm install --save firebase @brokeyourbike/reactfire

# or

# yarn
yarn add firebase reactfire
yarn add firebase @brokeyourbike/reactfire
```

Depending on your targeted platforms you may need to install polyfills. The most commonly needed will be [globalThis](https://caniuse.com/#search=globalThis) and [Proxy](https://caniuse.com/#search=Proxy).
Expand All @@ -30,7 +30,6 @@ Depending on your targeted platforms you may need to install polyfills. The most
- [**Quickstart**](./docs/quickstart.md)
- [**Common Use Cases**](./docs/use.md)
- [**API Reference**](./docs/reference)
- [**v3 -> v4 Upgrade Guide**](./docs/upgrade-guide.md)

## Example use

Expand All @@ -42,7 +41,7 @@ import React from 'react';
import { render } from 'react-dom';

import { doc, getFirestore } from 'firebase/firestore';
import { FirebaseAppProvider, FirestoreProvider, useFirestoreDocData, useFirestore, useFirebaseApp } from 'reactfire';
import { FirebaseAppProvider, FirestoreProvider, useFirestoreDocData, useFirestore, useFirebaseApp } from '@brokeyourbike/reactfire';

const firebaseConfig = {
/* Add in your config object from the Firebase console */
Expand Down Expand Up @@ -104,4 +103,4 @@ Enable concurrent mode features by following the [concurrent mode setup guide](h
<FirebaseAppProvider firebaseConfig={firebaseConfig} suspense={true}>
```

See concurrent mode code samples in [example/withSuspense](https://github.com/FirebaseExtended/reactfire/tree/main/example/withSuspense)
See concurrent mode code samples in [example/withSuspense](https://github.com/brokeyourbike/reactfire/tree/main/example/withSuspense)
4 changes: 2 additions & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ npm install --save firebase reactfire

```js
//...
import { FirebaseAppProvider } from 'reactfire';
import { FirebaseAppProvider } from '@brokeyourbike/reactfire';
//...
```

Expand Down Expand Up @@ -124,7 +124,7 @@ npm install --save firebase reactfire
```js
//...
import { doc, getFirestore } from 'firebase/firestore';
import { FirestoreProvider, useFirestoreDocData, useFirestore, useFirebaseApp } from 'reactfire';
import { FirestoreProvider, useFirestoreDocData, useFirestore, useFirebaseApp } from '@brokeyourbike/reactfire';
//...
```

Expand Down
Loading