Skip to content

Commit fec6567

Browse files
committed
fix(README): fix inline notes formatting
1 parent 3e62acc commit fec6567

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ yarn build
8181
yarn dev
8282
```
8383

84-
> ![NOTE]
84+
> [!NOTE]
8585
> A cloud-based Firebase project must still exist in order to run the emulator locally in this manner. Simply create a blank/empty [Firebase](https://firebase.google.com/) project using a Google account for this purpose, and then populate file `website/.env` accordingly with corresponding API key and project information from Firebase (see `website/example.env` for additional reference, as well as `website/__seed__/README.md` for more information regarding seeding a cloud-based Firebase Firestore database).
8686
8787
Open `http://localhost:3000` with your browser to see the result. The local data will be seeded from scratch. Furthermore, you can use the local auth service by simply logging in via any of the provided services (e.g., Google) with auto-generated credentials, which will simulate a logged in user account.

__seed__/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ reviewsData
2121
usersData
2222
/{userId}: <User>
2323
```
24-
> ![NOTE]
24+
> [!NOTE]
2525
> The canonical path format for Firebase Firestore is `{collectionName}/{documentId}/{subCollectionName}/{subDocumentId}/...` and so on, with the path terminating at a (sub)document.
2626
2727
## Seeding a Firebase project
2828

29-
> ![NOTE]
29+
> [!NOTE]
3030
> All paths indicated in this section are relative to the top-level directory (i.e., `website`). Furthermore, all commands (i.e., `yarn ...`) should also be issued from the top-level directory accordingly.
3131
3232
### Seeding or updating a cloud Firebase project
@@ -37,7 +37,7 @@ To seed the data in a development cloud-based Firebase Firestore database, defin
3737
yarn fb:seed-db-cloud
3838
```
3939

40-
> ![WARNING]
40+
> [!WARNING]
4141
> Do **NOT** use this method in **production**!!! Production Firebase database must be updated manually via the Firebase UI/console; otherwise, this seeding approach will wipe all of the live data **without** ability to recover it!
4242
4343
### Seeding or updating local *Firebase Emulator Suite*
@@ -81,7 +81,7 @@ This will update the corresponding files in directory `/__seed__/firebase-seed`.
8181

8282
## Adding a new course
8383

84-
> ![NOTE]
84+
> [!NOTE]
8585
> All paths indicated here are relative to the top-level directory (i.e., `website`).
8686
8787
To add a new course, update the following files:

firebase/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
## Preliminaries
44

5-
> ![NOTE]
5+
> [!NOTE]
66
> All file-path references assume a starting point of the root directory of the project unless noted otherwise.
77
8-
> ![NOTE]
8+
> [!NOTE]
99
> Requires Node v. 20+.
1010
1111
## Overview
@@ -48,7 +48,7 @@ The data documents defined in this app, and their corresponding CRUD operations'
4848
| `Review` | `getReviews(courseId, year, semesterTerm)` | `getReview(reviewId)` | `addReview(userId, reviewId, data)` | `updateReview(userId, reviewId, data)` | `deleteReview(userId, reviewId)` |
4949
| `User` | (N/A) | `getUser(id)` | `addUser(id)` | `updateUser(id)` | `deleteUser(id)` |
5050

51-
> ![NOTE]
51+
> [!NOTE]
5252
> See `/globals/types.ts` for definition of document data fields (i.e., argument `data` per above).
5353
5454
Example usage via `courses` document (and similarly for the others):
@@ -98,5 +98,5 @@ await updateCourse(courseId, updatedCourseData)
9898
await deleteCourse(courseId)
9999
```
100100

101-
> ![NOTE]
101+
> [!NOTE]
102102
> All non-"`GET`" operations require authorization/authentication via Firebase Authentication and corresponding permissions.

functions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This sub-repo contains the definitions for the Firebase Cloud Functions, intende
66

77
### Cloud Firebase Project
88

9-
> ![WARNING]
9+
> [!WARNING]
1010
> Deploying Cloud Functions requires a ***paid plan*** Firebase project, which must be preconfigured as such accordingly prior to deployment.
1111
1212
To deploy the cloud functions as defined in `/website/functions/index.js` to a cloud-based Firebase project, ensure that the terminal is in location `.../website/functions/` and then perform the following steps via terminal:

0 commit comments

Comments
 (0)