docs: update and correct documentation

- Updates the README.md file to be more accurate and to point to the
  documentation in the docs/ directory.
- Updates the documentation in the docs/ directory to be more complete
  and to correct stale information.

Author: rafikhan

firestore/README.md

@@ -32,9 +32,9 @@ Follow these steps to setup and run the quickstart:
     npm -g i firebase-tools
     ```
 
- 1. Install and build all project dependencies
+ 1. Install all project dependencies
     ```bash
-    npm install && (cd functions && npm install)
+    npm install && (cd functions && npm install) && (cd scripts && npm install)
     ```
 
     > **Note:** When modifying the contents of `functions/src`, be sure to run `npm run build` in the `functions/` directory so that Typescript changes can be compiled and present in the next emulator run.
@@ -49,7 +49,9 @@ Follow these steps to setup and run the quickstart:
 
 Follow these steps to have a working version of the quickstart running with the Firebase console:
 
-   > **Note:** In the original application (that runs on the emulators), there is a Firebase Function that updates the `avgRating` field of a restaurant whenever that restaurant recieves a review. While **Authentication**, **Storage**, and **Firestore** are offered as free services through the Firebase console, using Firebase **Functions** on the Firebase Console requires a billing plan. There is a [free tier billing plan](https://firebase.google.com/pricing) that allows up to 2 million free function calls per month, but enabling this plan requires presenting payment information to Firebase. The following instructions, therefore, exclude those steps needed to deploy and host functions on the Firebase Console. All application functionality, other than the auto-updating `avgRating` field for restaurants, is conserved.
+   > **Note on Billing:** Firebase offers two main pricing plans: the Spark Plan (free) and the Blaze Plan (pay-as-you-go). The Spark Plan has a generous free tier for many services, including Cloud Functions. If you exceed the limits of the Spark Plan, your app's usage of that particular service will be capped for the rest of the billing cycle to prevent any charges. The Blaze Plan gives you the same free tier as the Spark Plan, but you are billed for any usage that exceeds those limits.
+   >
+   > For more information, see the [Firebase pricing page](https://firebase.google.com/pricing).
 
  1. Create a new Firebase project in the [Firebase Console](https://console.firebase.google.com)
 
@@ -90,7 +92,7 @@ Follow these steps to have a working version of the quickstart running with the
  ```bash
  npm run production
  ```
- > **Note:** If you've opted to set up a billing plan and wish to deploy functions as well, replace the `firebase deploy --only firestore` on line 8 of `package.json` with `firebase deploy`.
+ > **Note:** If you've opted to set up a billing plan and wish to deploy functions as well, replace the `firebase deploy --only firestore` on line 9 of `package.json` with `firebase deploy`.
 
  11. (Optional) Populate production Firestore with mock data
 

firestore/docs/backend.md

@@ -15,3 +15,9 @@ The following commands are available for the backend (run from the `functions` d
 The Firebase Functions are located in the `functions/src/index.ts` file. Here is a brief overview of their purpose:
 
 *   **`updateNumRatings`**: This function is triggered when a new rating is added to a restaurant's `ratings` sub-collection. It recalculates the average rating for the restaurant and updates the `avgRating` and `numRatings` fields in the corresponding restaurant document.
+
+## Note on Billing
+
+Firebase offers two main pricing plans: the Spark Plan (free) and the Blaze Plan (pay-as-you-go). The Spark Plan has a generous free tier for many services, including Cloud Functions. If you exceed the limits of the Spark Plan, your app's usage of that particular service will be capped for the rest of the billing cycle to prevent any charges. The Blaze Plan gives you the same free tier as the Spark Plan, but you are billed for any usage that exceeds those limits.
+
+For more information, see the [Firebase pricing page](https://firebase.google.com/pricing).

firestore/docs/data-model.md

@@ -4,7 +4,7 @@ The Friendly Eats application uses two main collections in Firestore: `restauran
 
 ## `restaurants`
 
-This collection contains a document for each restaurant. The structure of a restaurant document is as follows:
+This collection contains a document for each restaurant. The structure of a restaurant document is defined in the [`restaurant.ts`](../src/types/restaurant.ts) file.
 
 *   `id` (string): The unique identifier for the restaurant.
 *   `avgRating` (number): The average rating of the restaurant.
@@ -17,11 +17,11 @@ This collection contains a document for each restaurant. The structure of a rest
 
 ## `ratings`
 
-This is a sub-collection of a restaurant document. It contains a document for each rating that a restaurant has received. The structure of a rating document is as follows:
+This is a sub-collection of a restaurant document. It contains a document for each rating that a restaurant has received. The structure of a rating document is defined in the [`ratings.ts`](../src/types/ratings.ts) file.
 
 *   `id` (string, optional): The unique identifier for the rating.
 *   `rating` (number): The rating given by the user (1-5).
 *   `text` (string): The text of the review.
 *   `timestamp` (Date, optional): The timestamp of the review.
 *   `userId` (string, optional): The ID of the user who submitted the review.
-*   `userName` (string, optional): The name of the user who submitted the review.
+*   `userName` (string, optional): The name of the user who submitted the review.

firestore/docs/setup.md

@@ -9,6 +9,13 @@ This document provides step-by-step instructions for setting up the Friendly Eat
 *   [Angular CLI](https://angular.io/cli)
 *   [Firebase CLI](https://firebase.google.com/docs/cli)
 
+To install the CLIs globally, run the following commands:
+
+```bash
+npm install -g @angular/cli
+npm install -g firebase-tools
+```
+
 ## Installation
 
 1.  **Clone the repository:**
@@ -73,4 +80,4 @@ This document provides step-by-step instructions for setting up the Friendly Eat
     *   **For a production project:**
         ```bash
         npm run populate-production
-        ```
+        ```