You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* commented firebase notification code, and removed Firebase related installation and configuration instructions
* removed all references of firebase
* removed firebase-admin package
Copy file name to clipboardexpand all lines: INSTALLATION.md
-85
Original file line number
Diff line number
Diff line change
@@ -40,9 +40,6 @@ This document provides instructions on how to set up and start a running instanc
40
40
-[Setting up Logger configurations _(optional)_](#setting-up-logger-configurations-optional)
41
41
-[Setting up COLORIZE_LOGS in .env file](#setting-up-colorize_logs-in-env-file)
42
42
-[Setting up LOG_LEVEL in .env file](#setting-up-log_level-in-env-file)
43
-
-[Configuring Google Firebase](#configuring-google-firebase)
44
-
-[Generate Firebase Keys for the Talawa Notification Service](#generate-firebase-keys-for-the-talawa-notification-service)
45
-
-[(Mobile Developers Only) Applying the Firebase Keys to the Talawa Mobile App](#mobile-developers-only-applying-the-firebase-keys-to-the-talawa-mobile-app)
@@ -529,88 +526,6 @@ There are different logging levels that can be configured by setting this parame
529
526
<br><br>
530
527
For our application, the most appropriate setting is `LOG_LEVEL = info` since most of information logged on the console are error messages, warnings or info texts.
531
528
532
-
## Configuring Google Firebase
533
-
534
-
You need to have a `google` account to follow the following steps.
535
-
536
-
<br/>
537
-
538
-
### Generate Firebase Keys for the Talawa Notification Service
539
-
540
-
We use firebase for mobile app notifications. To configure the notification service create a new firebase project and follow these steps:-
541
-
542
-
1. Create a new Firebase project for Talawa-API
543
-
1. When created you will automatically enter the project's console area
544
-
1. Click on the settings icon beside the `Project Overview` heading
545
-
1. Click on `Project Settings`
546
-
1. Click on the `Service Accounts` tab
547
-
1. Click on the `Node.js` radio button
548
-
1. Click on `Generate New Private Key` button
549
-
1. Confirm by clicking on `Generate Key`. This will automatically download the private keys in your browser.
550
-
1. Securely store the `JSON` file containing the private key. These will be used in the next section.
551
-
552
-
### (Mobile Developers Only) Applying the Firebase Keys to the Talawa Mobile App
553
-
554
-
The key generated in the previous step is in a format suitable for use in a mobile app. We need to convert it for use by the API. This will require you to do some work in the talawa repository to do the necessary conversion. The resulting output will be stored in a `lib/firebase_options.dart` file. Some of the contents of this file will then need to be added to the API's `.env` file. Here we go.
555
-
556
-
1. Clone the talawa mobile app in a separate directory that is not under your Talawa-API directory.
557
-
1. Enter that directory as you will need to edit files there
558
-
1. Run the following commands to set the key in the environment variable for your respective operating system:
1. Install the [Firebase CLI](https://firebase.google.com/docs/cli#install_the_firebase_cli).
569
-
1. Save the original copy the `lib/firebase_options.dart` file as it will be modified.
570
-
1. Run the following commands in the project directory of talawa mobile app:
571
-
572
-
firebase login
573
-
574
-
dart pub global activate flutterfire_cli
575
-
576
-
1. Run any commands about exporting variables from the previous `dart` command.
577
-
1. Run the following command to configure the application for Firebase
578
-
`flutterfire configure`
579
-
1. Select the project you created in the firebase console.
580
-
1. Add `iOS` and `android` platforms to the project.
581
-
1. Overwrite the `firebase_options.dart` file if asked so.
582
-
1. The command will generate keys forthe `iOS` and `android` platforms respectively and place themin the `firebase_options.dart` file.
583
-
1. Edit the `firebase_options.dart` file.
584
-
1. Add the parameters in the `static const FirebaseOptions android = FirebaseOptions` section of the `firebase_options.dart` file to the Talawa API `.env` file under the `androidFirebaseOptions` heading.
585
-
586
-
1. Replace any parameters that are already there in that section.
587
-
1. Remove any trailing commas on the lines you have added.
588
-
1. Remove any leading spaces on the lines you have added.
589
-
1. The final result in the `.env` file should look like this
1. Add the parameters in the `static const FirebaseOptions ios = FirebaseOptions` section of the `firebase_options.dart` file to the Talawa API `.env` file under the `iosFirebaseOptions` heading. Replace any paramters that are already there.
598
-
599
-
1. Replace any parameters that are already there in that section.
600
-
1. Remove any trailing commas on the lines you have added.
601
-
1. Remove any leading spaces on the lines you have added.
602
-
1. The final result in the `.env` file should look like this
0 commit comments