Skip to content

Commit 4cfedb8

Browse files
committed
chore: update README
1 parent f14c8bb commit 4cfedb8

File tree

5 files changed

+19
-4
lines changed

5 files changed

+19
-4
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ The following dependecies are used for this project. Feel free to experiment usi
1313
- node v18.14.2
1414
- npm v9.5.0
1515
- > **NOTE:** We will use v18.14.2 for the official production client and server builds but feel free to use other NodeJS versions by setting "engine-strict=false" in the .npmrc file when working on localhost development as needed, but please use v18.14.2 when installing new modules. Do not commit the package.json or package-lock.json files should they change when "engine-strict=false".
16+
4. React Developer Tools (optional) [[link]](https://react.dev/learn/react-developer-tools)
17+
- The React Developer Tools is a web browser extension for debugging React apps.
18+
- It's best to view these demos with the React Profiler, one of the tools available in the React Developer Tools for observing the components re-rendering on state updates.
19+
- Install for [Chrome](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
20+
- Install for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/react-devtools/)
21+
- Install for [Edge](https://microsoftedge.microsoft.com/addons/detail/react-developer-tools/gpphkfbcpidddadnkolkpfckpihlkkil)
1622

1723
### Core Libraries and Frameworks
1824

@@ -31,10 +37,18 @@ The following dependecies are used for this project. Feel free to experiment usi
3137

3238
### Manual Installation and Usage
3339

40+
> It's best to view these demos with the React Profiler, one of the tools available in the React Developer Tools for observing the components re-rendering on state updates.
41+
3442
1. Navigate to the **/client** directory from the commandline.
35-
2. Create a `.env` file from the `/client/.env.example` file. Copy it's content when working on localhost.
43+
2. Create a `.env` file from the `/client/.env.example` file. Copy its content when working on localhost.
3644
3. Run: `npm run install`
3745
4. Run: `npm run dev`
46+
5. Open the localhost website on `http://localhost:3000`
47+
48+
### Using the React Profiler
49+
50+
1. Open the React Profiler in the web browser's developer console.
51+
2. Run the demos and observe the components re-rendering. The Profiler highlights rendered components.
3852

3953
### Localhost Development Using Docker
4054

client/src/components/home/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export default function HomeComponent() {
1616
<h1 className={inter.className}>
1717
React Hooks Playground
1818
</h1>
19+
<p>Best viewed with React Profiler</p>
1920
</div>
2021

2122
{navlinks.map((item, index) => (

client/src/features/memo/components/fulltable/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ function FullTable () {
4242
return (
4343
<div className={styles.container}>
4444
<div className={styles.subDescription}>
45-
<h3>Full Table re-rendering</h3>
45+
<h3>Full Table re-rendering (WARNING!) ❌</h3>
4646
<ul>
4747
<li>On edit, this table renders the object array data using map(), rendering the full table.</li>
4848
</ul>

client/src/features/memo/components/memoizedtable/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const MemoizedTable = () => {
3939
return (
4040
<div className={styles.container}>
4141
<div className={styles.subDescription}>
42-
<h3 style={{ color: 'green' }}>Optimized Table row re-rendering</h3>
42+
<h3 style={{ color: 'green' }}>Optimized Table row re-rendering ✔️</h3>
4343
<ul>
4444
<li>This table renders the object array data using map().</li>
4545
<li>On edit, it renders only an &quot;updated&quot; table row using a memoized TableRow component.</li>

client/src/features/memo/components/unoptimizedtable/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const UnoptimizedTable = () => {
3939
return (
4040
<div className={styles.container}>
4141
<div className={styles.subDescription}>
42-
<h3 style={{ color: 'red' }}>Table re-rendering all rows (WARNING!)</h3>
42+
<h3 style={{ color: 'red' }}>Table re-rendering all rows (WARNING!)</h3>
4343
<ul>
4444
<li>This table renders the object array data using map().</li>
4545
<li>It&lsquo;s using a memoized TableRow component but</li>

0 commit comments

Comments
 (0)