Skip to content

Commit 13bc9ae

Browse files
readme notes
1 parent c248b27 commit 13bc9ae

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,23 @@ Sample project motivated by [video by David East](https://www.youtube.com/watch?
88
- In this project I use [Reactfire](https://github.com/FirebaseExtended/reactfire), [Ionic Framework ReactJS Components](https://ionicframework.com/react) and [React-Hook-Form](https://react-hook-form.com/).
99
- We use the `<AuthCheck/>` component for cleaner routing when not logged in, See [App.tsx](https://github.com/aaronksaunders/ionic-react-hook-form-react-fire/blob/master/src/App.tsx)
1010
- Currently there is only [Login](https://github.com/aaronksaunders/ionic-react-hook-form-react-fire/blob/master/src/pages/Login.tsx) and [Listing The Data Collection](https://github.com/aaronksaunders/ionic-react-hook-form-react-fire/blob/master/src/pages/Home.tsx)
11-
- Will be adding create user, add items and delete items
11+
- Will be adding delete items
12+
13+
### Saves The Following Data Structure
14+
I am starting to integrated typescript into my examples since I am seeing questions about types popping up in the forums. The `IModalData` is the structure of the data that is written to firebase
15+
```
16+
type IModalData = {
17+
podcastName: string;
18+
podcastHost: string;
19+
podcastURL: string;
20+
};
21+
22+
export type IModalResponse = {
23+
hasData: boolean;
24+
data?: IModalData;
25+
};
26+
27+
```
1228

1329
### Required
1430
you must create a file called `src/env.js` and add the following code
@@ -18,7 +34,7 @@ export const FIREBASE_CONFIG = {
1834
};
1935

2036
// NAME OF COLLECTION IN FIREBASE TO LIST
21-
export const FIREBASE_COLLECTION_NAME = "users"
37+
export const FIREBASE_COLLECTION_NAME = "podcast-favs"
2238

2339
// THIS IS REQUIRED FOR ANDROID
2440
// SEE - https://github.com/FirebaseExtended/reactfire/issues/228

0 commit comments

Comments
 (0)