Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Improve documentation about adding the Firebase SDK #205

Open
basvdijk opened this issue Sep 22, 2022 · 12 comments · Fixed by #316
Open

feat: Improve documentation about adding the Firebase SDK #205

basvdijk opened this issue Sep 22, 2022 · 12 comments · Fixed by #316
Labels
docs Improvements or additions to documentation

Comments

@basvdijk
Copy link

Is your feature request related to a problem? Please describe:

Most Capacitor plugins do not require to add an SDK to the iOS or Android project itself.

Describe the solution you'd like:

A clear instruction how to add the SDK to my project. The firebase documentation to which is linked assumes you have a 100% native app. For example on iOS it is unclear for me to which project I have to add the Firebase SDK. The app project or the pod project?

Describe alternatives you've considered:

Additional context:

@basvdijk basvdijk changed the title feat: Improve documentation about adding the SDK feat: Improve documentation about adding the Firebase SDK Sep 22, 2022
@robingenz robingenz added docs Improvements or additions to documentation and removed needs: triage labels Sep 22, 2022
@basvdijk
Copy link
Author

@robingenz I decided to write my own documentation for Android and iOS. Also added a demo project in order to test Firebase Analytics screen changes. Maybe my documentation could be helpful to other developers: https://github.com/basvdijk/capacitor4-firebase-analytics-example-project-capawesome-team

@robingenz
Copy link
Member

@basvdijk Thank you! I will use this as inspiration.

@ubaranzorlu
Copy link

Support

@piotr-cz
Copy link
Contributor

piotr-cz commented Feb 10, 2023

Too bad that I have found this issue just after hours of debugging of what's wrong.

The thing is to skip the * Add Firebase SDKs to your app* and Initialize Firebase in your app steps from the iOS guide

@robingenz
Copy link
Member

The thing is to skip the * Add Firebase SDKs to your app* and Initialize Firebase in your app steps from the iOS guide

Sorry for that. I have just seen that Firebase has reworked the documentation. I will update the installation instructions.

@robingenz
Copy link
Member

@piotr-cz I updated the docs: #316

@piotr-cz
Copy link
Contributor

@robingenz Thank you for preparing updated instructions, I'm sure it would help new devs!

@szymon-mutuu
Copy link

isn't this plugin supposed to configure all the sdk? how to proceed for cicd?

@robingenz
Copy link
Member

isn't this plugin supposed to configure all the sdk?

@szymon-mutuu No, this plugin allows you to use the Firebase SDKs in Capacitor. But you have to configure the SDKs yourself.

how to proceed for cicd?

Nothing special. You configure the Android and iOS projects during setup according to the documentation and push the state to git. The CI then has all the information it needs. If for some reason you don't want to push files such as GoogleService-Info.plist to git, then you can easily add them via CI before the build (example). Nothing special here either.

If you have more questions, please create a discussion. These questions are off topic.

@szymon-mutuu
Copy link

thanks @robingenz for prompt response!
Am I correct it assumes keeping ios project in the repo? 🤔 I don't have ios/android projects in the repo and all works well so far for pretty complex project. I think pushing ios project to the repo is not a good idea since there is little control over any changes to binary files being consequence of using Xcode...

I think there should be a way to make this automated and that there were some eg cordova projects installing firebase sdk in a headless way. I appreciate existence of this project, just loudly thinking how it possibly be improved...

@robingenz
Copy link
Member

If you have more questions, please create a discussion. These questions are off topic.

@szymon-mutuu As already said, please create a discussion and link your comment.

@szymon-mutuu
Copy link

sure, also here for reference #338

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants