Skip to content

Commit b5e3231

Browse files
committed
docs: Update local dev docs
1 parent f289554 commit b5e3231

File tree

4 files changed

+25
-1101
lines changed

4 files changed

+25
-1101
lines changed

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,45 @@ FirebaseUI requires the `firebase` package to be installed:
1010
npm install firebase
1111
```
1212

13+
(Since the packages are not published, the peer dependencies are not installed automatically from source (core & styles). This will not be required once published.)
14+
1315
Next, follow the installation flow for your framework:
1416

1517
<details>
1618
<summary>React</summary>
1719

18-
```bash
19-
npm install @firebase-ui/react
20+
```json
21+
{
22+
"dependencies": {
23+
"@firebase-ui/core": "path-to-repo/releases/firebase-ui-core-0.0.1.tgz",
24+
"@firebase-ui/styles": "path-to-repo/releases/firebase-ui-styles-0.0.1.tgz",
25+
"@firebase-ui/react": "path-to-repo/releases/firebase-ui-react-0.0.1.tgz"
26+
}
27+
}
2028
```
2129

30+
(Once published, this will be `npm install @firebase-ui/react`)
31+
2232
</details>
2333

2434
<details>
2535
<summary>Angular</summary>
2636

2737
FirebaseUI for Angular depends on the [AngularFire](https://github.com/angular/angularfire) package:
2838

29-
```bash
30-
npm install @firebase-ui/angular @angular/fire
39+
```json
40+
{
41+
"dependencies": {
42+
"@firebase-ui/core": "path-to-repo/releases/firebase-ui-core-0.0.1.tgz",
43+
"@firebase-ui/styles": "path-to-repo/releases/firebase-ui-styles-0.0.1.tgz",
44+
"@firebase-ui/amgular": "path-to-repo/releases/firebase-ui-angular-0.0.1.tgz",
45+
"@angular/fire": "^19.0.0"
46+
}
47+
}
3148
```
3249

50+
(Once published, this will be `npm install @firebase-ui/angular @angular/fire`)
51+
3352
</details>
3453

3554
## Setup
@@ -94,7 +113,7 @@ Next, follow the flow for your framework to setup FirebaseUI:
94113
export const appConfig: ApplicationConfig = {
95114
providers: [
96115
provideFirebaseApp(() => initializeApp({ ... })),
97-
provideFirestore(() => getFirestore()),
116+
provideAuth(() => getAuth()),
98117
provideFirebaseUI(() => initializeUI({}))
99118
...
100119
],
@@ -173,22 +192,6 @@ Allows users to sign in with an email and password:
173192
})
174193
export class AppComponent { }
175194
```
176-
177-
TODO: Props: `onForgotPasswordClick` / `onRegisterClick`
178-
179-
TODO: Additionally, allow the user to sign in with an OAuth provider by providing children:
180-
181-
```tsx
182-
import { SignUpAuthScreenComponent } from "@firebase-ui/angular";
183-
184-
@Component({
185-
selector: 'app-root',
186-
imports: [SignUpAuthScreenComponent],
187-
template: `<fui-sign-up-auth-screen></fui-sign-up-auth-screen>`,
188-
})
189-
export class AppComponent { }
190-
```
191-
192195
</details>
193196

194197
## Configuration

0 commit comments

Comments
 (0)