Browse Source

Misc doc fixes

katowulf-pr-tpl
Chris Raynor 8 years ago
parent
commit
54e5426c89
  1. 1
      .gitignore
  2. 4
      email-confirmation/README.md
  3. 12
      email-confirmation/public/index.html
  4. 8
      fcm-notifications/README.md
  5. 9
      text-moderation/README.md

1
.gitignore

@ -1,2 +1,3 @@
.idea
**/node_modules/*
**/.firebaserc

4
email-confirmation/README.md

@ -42,8 +42,8 @@ firebase functions:config:set gmail.email="myusername@gmail.com" gmail.password=
This sample comes with a web-based UI for testing the function. To set it up:
- Create a Firebase Project using the Firebase Developer Console
- Enable Google Provider in the Auth section
- Create a Firebase Project using the [Firebase Developer Console](https://console.firebase.google.com)
- Enable Google Provider in the [Auth section](https://console.firebase.google.com/project/_/authentication/providers)
- Import and configure Firebase in the `public/index.html` where the `TODO` is located

12
email-confirmation/public/index.html

@ -101,18 +101,6 @@
* TODO(DEVELOPER): Paste the initialization snippet from: Firebase Console > Overview > Add Firebase to your web app. *
*********************************************************************************************************************** -->
<script src="https://www.gstatic.com/firebasejs/3.4.1/firebase.js"></script>
<script>
// Initialize Firebase
var config = {
apiKey: "AIzaSyAu14Qhq_t4GbyZlRwVlFVLellEo4Gjmzs",
authDomain: "functions-email-confirmation.firebaseapp.com",
databaseURL: "https://functions-email-confirmation.firebaseio.com",
storageBucket: "functions-email-confirmation.appspot.com",
messagingSenderId: "207174568617"
};
firebase.initializeApp(config);
</script>
<script src="main.js"></script>
</body>
</html>

8
fcm-notifications/README.md

@ -53,9 +53,9 @@ The function triggers every time the value of a follow flag changes at `/followe
This sample comes with a web-based UI for testing the function. To test it out:
- Create a Firebase Project using the Firebase Developer Console
- Enable billing since Functions require billing.
- Enable Google Provider in the Auth section
- Import and configure Firebase in the `index.html` where the `TODO` is located
- Create a Firebase Project using the [Firebase Developer Console](https://console.firebase.google.com)
- Enable Google Provider in the [Auth section](https://console.firebase.google.com/project/_/authentication/providers)
- Import and configure Firebase in `public/index.html` where the `TODO` is located
- Install the required dependencies by running `npm install` in the `functions` directory
- Deploy your project using `firebase deploy`
- Open the app and start following a user, this will send a notification to him.

9
text-moderation/README.md

@ -50,16 +50,15 @@ The function triggers every time a message is modified. It exits if the message
## Security Rules
The security rules only allow users to create message but not edit them afterwards. Also it does not allows users to set the `sanitized` value. Only the Functions is allowed to modify `sanitized` by using an admin authorized reference.
The security rules only allow users to create message but not edit them afterwards. Also it does not allow users to set the `sanitized` value. Only the Cloud Function is allowed to modify `sanitized` by using an admin authorized reference.
## Deploy and test
This sample comes with a web-based UI for testing the function. To test it out:
- Create a Firebase Project using the Firebase Developer Console
- Enable Google Provider in the Auth section
- Import and configure Firebase in the `index.html` where the `TODO` is located
- Create a Firebase Project using the [Firebase Developer Console](https://console.firebase.google.com)
- Import and configure Firebase in `public/index.html` where the `TODO` is located
- Install the required dependencies by running `npm install` in the `functions` directory
- Deploy your project using `firebase deploy`
- Open the app and add messages to the message board. Try to ad bad words into your message and they should get moderated.

Loading…
Cancel
Save