Skip to content

Commit f2f0e52

Browse files
committed
docs: update references text content
1 parent 5c12760 commit f2f0e52

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

docs/pages/directories/client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { FileTree, Callout } from 'nextra/components'
22

33
# Client
44

5-
The **client** directory contains codes and configurations/settings for the (React) NextJS front end and Firebase. The folder tree displays the relevant files and folders.
5+
The **client** directory contains codes and configurations/settings for the (React) NextJS v13 + Material UI v5 front end and Firebase. The folder tree displays the relevant files and folders.
66

77
The NextJS frontend uses the [**pages router**](https://nextjs.org/docs/pages) since this is suitable for generating static pages to host on GitHub Pages. It uses the `"container component"` as a dominant pattern, also known as `"component and presentational"` components, for distinguishing between logic (container) and UI (component).
88

docs/pages/references.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,17 @@ This section contains URL links to partners and various online references used b
2323

2424
<div className="text-semibold text-sm text-purple-500 no-underline hover:underline">
2525
- [NextJS](https://nextjs.org/)
26-
- [Material UI](https://mui.com/material-ui/)
26+
- [Material UI 5 (MUI5)](https://mui.com/material-ui/) - version 5 (v5)
2727
- [GitHub Pages](https://pages.github.com/)
28+
- [Firebase JavaScript SDK](https://firebase.google.com/docs/web/setup) - Firebase Authentication, Cloud Firestore and Cloud Storage
2829
- [Firebase Hosting](https://firebase.google.com/docs/hosting/)
2930
</div>
3031

3132
### Backend
3233

3334
<div className="text-semibold text-sm text-purple-500 no-underline hover:underline">
3435
- [NodeJS](https://nodejs.org/en)
35-
- [Firebase Admin SDK](https://firebase.google.com/docs/admin/setup)
36+
- [Firebase Admin SDK](https://firebase.google.com/docs/admin/setup) - Firebase Auth, Cloud Firestore and Cloud Storage
3637
- [Render](https://render.com/)
3738
- [Vercel](https://vercel.com/)
3839
- [GitHub Actions](https://docs.github.com/en/actions)

docs/pages/requirements.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This post describes the dependencies and requirements needed to run run ACAP 1.0
1414
#### Main Development
1515

1616
1. Visual Studio Code (VSCode) IDE
17-
- version: v1.79.2 (any version that can run NodeJS)
17+
- version: v1.79.2 (or versions capable of running NodeJS in its Integrated Terminal)
1818
2. nvm
1919
- <Callout>
2020
**nvm** is optional, if you can install NodeJS LTS version 16.14.2 on **item #3**
@@ -45,12 +45,12 @@ This post describes the dependencies and requirements needed to run run ACAP 1.0
4545
3. JavaScript
4646
4. GitHub
4747
5. Firebase
48-
- Firebase for Web
49-
- Firebase for NodeJS (Firebase Admin)
50-
- Firebase Services (Components)
48+
- [Firebase JavaScript SDK (for frontend web clients)](https://firebase.google.com/docs/web/setup)
49+
- [Firebase Admin SDK (for backend NodeJS)](https://firebase.google.com/docs/admin/setup)
50+
- Firebase Services (Components) - used within the contexts of the **Firestore JavaScript SDK** and the **Firebase Admin SDK**
5151
- Authentication <sup>[[1]](https://firebase.google.com/docs/auth/)</sup>
52-
- Firestore <sup>[[2]](https://firebase.google.com/docs/firestore/)</sup>
53-
- Storage <sup>[[3]](https://firebase.google.com/docs/storage/)</sup>
52+
- Firestore (Cloud Firestore) <sup>[[2]](https://firebase.google.com/docs/firestore/)</sup>
53+
- Storage (Cloud Storage) <sup>[[3]](https://firebase.google.com/docs/storage/)</sup>
5454
- Hosting <sup>[[4]](https://firebase.google.com/docs/hosting/)</sup> _(Only used with the **development** environment)_
5555

5656
### Cloud Service Accounts (standard pricing)

0 commit comments

Comments
 (0)