Skip to content

Commit 14ea529

Browse files
authored
Remove all references to sample-complex and sample-simple (#187)
* remove all references to sample-complex * remove sample-simple too
1 parent 2c02415 commit 14ea529

File tree

5 files changed

+31
-18
lines changed

5 files changed

+31
-18
lines changed

.dockerignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@ reactfire/**/*.jsx.map
1919
reactfire/**/*.d.ts
2020
reactfire/pub/*
2121
reactfire/docs/reactfire-metadata.json
22-
.cache
23-
sample-complex/src/firebase-key.json
22+
.cache

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ node_modules/
99

1010

1111
reactfire/docs/reactfire-metadata.json
12-
sample-complex/.cache/**
13-
sample-complex/src/firebase-key.json
1412
reactfire/firestore-debug.log
1513
reactfire/pub/**
1614
pub

Dockerfile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ ENV PYTHON /usr/bin/python2.7
1919
COPY package.json /
2020
COPY yarn.lock /
2121
COPY reactfire/package.json reactfire/
22-
COPY sample-complex/package.json sample-complex/
23-
COPY sample-simple/package.json sample-simple/
22+
COPY sample/package.json sample/
2423
RUN yarn install --frozen-lockfile
2524

2625
COPY . /

README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,29 @@
11
# Reactfire
22

3-
Hooks, Context Providers, and Components that make it easy
4-
to interact with Firebase.
3+
Hooks, Context Providers, and Components that make it easy to interact with
4+
Firebase.
55

6-
> If you're looking for docs for the _deprecated_ ReactFire v1 (the one that uses mixins), click [here](https://github.com/FirebaseExtended/reactfire/tree/v1.0.0)
6+
> If you're looking for docs for the _deprecated_ ReactFire v1 (the one that
7+
> uses mixins), click
8+
> [here](https://github.com/FirebaseExtended/reactfire/tree/v1.0.0)
79
8-
**Status: Alpha**. ReactFire is meant for React Concurrent Mode, which is only available in [experimental React builds](https://reactjs.org/docs/concurrent-mode-adoption.html#installation).
10+
**Status: Alpha**. ReactFire is meant for React Concurrent Mode, which is only
11+
available in
12+
[experimental React builds](https://reactjs.org/docs/concurrent-mode-adoption.html#installation).
913

1014
## What is ReactFire?
1115

12-
- **Easy realtime updates for your function components** - Reactfire's hooks, like `useFirestoreCollection` and `useUser`, let you easily subscribe to events, and automatically unsubscribe when your component unmounts.
13-
- **Loading states handled by `<Suspense>`** - Reactfire's hooks throw promises that Suspense can catch. No more `isLoaded ?...` - let React [handle it for you](https://reactjs.org/blog/2018/11/27/react-16-roadmap.html#react-166-shipped-the-one-with-suspense-for-code-splitting).
14-
- **Dead-simple Real User Monitoring (RUM)** - Easily enable Firebase Performance Monitoring's [automatic traces](https://firebase.google.com/docs/perf-mon/automatic-web), and instrument your Suspenseful loads with Reactfire's `<SuspenseWithPerf>` component
16+
- **Easy realtime updates for your function components** - Reactfire's hooks,
17+
like `useFirestoreCollection` and `useUser`, let you easily subscribe to
18+
events, and automatically unsubscribe when your component unmounts.
19+
- **Loading states handled by `<Suspense>`** - Reactfire's hooks throw promises
20+
that Suspense can catch. No more `isLoaded ?...` - let React
21+
[handle it for you](https://reactjs.org/blog/2018/11/27/react-16-roadmap.html#react-166-shipped-the-one-with-suspense-for-code-splitting).
22+
- **Dead-simple Real User Monitoring (RUM)** - Easily enable Firebase
23+
Performance Monitoring's
24+
[automatic traces](https://firebase.google.com/docs/perf-mon/automatic-web),
25+
and instrument your Suspenseful loads with Reactfire's `<SuspenseWithPerf>`
26+
component
1527

1628
## Install
1729

@@ -26,7 +38,8 @@ If you like living life on the edge, use `reactfire@canary`.
2638

2739
## Example use
2840

29-
Check out the [live version on StackBlitz](https://stackblitz.com/edit/reactfire-sample)!
41+
Check out the
42+
[live version on StackBlitz](https://stackblitz.com/edit/reactfire-sample)!
3043

3144
```jsx
3245
import React, { Component } from 'react';
@@ -88,11 +101,15 @@ render(<App />, document.getElementById('root'));
88101

89102
### For development
90103

91-
1. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this repository (or a [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo#propose-changes-to-someone-elses-project))
104+
1. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
105+
this repository (or a
106+
[fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo#propose-changes-to-someone-elses-project))
92107
1. At the project root, install all modules by running `yarn install`.
93108
1. `cd` into the _reactfire_ directory. Run `yarn` and `yarn watch`.
94-
1. In a new terminal, `cd` into the _reactfire/sample-simple_ directory. run `yarn` and `yarn start`.
95-
1. Head over to https://localhost:3000 to see the running sample! If you edit the reactfire source, the sample will reload.
109+
1. In a new terminal, `cd` into the _reactfire/sample_ directory. run `yarn` and
110+
`yarn start`.
111+
1. Head over to https://localhost:3000 to see the running sample! If you edit
112+
the reactfire source, the sample will reload.
96113

97114
### Testing
98115

sample/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "sample-simple",
2+
"name": "sample",
33
"version": "0.1.0",
44
"private": true,
55
"dependencies": {

0 commit comments

Comments
 (0)