Skip to content

Commit 783f18c

Browse files
committed
update readme
1 parent f0ca9fc commit 783f18c

File tree

1 file changed

+46
-8
lines changed

1 file changed

+46
-8
lines changed

README.md

Lines changed: 46 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
# Getting Started with React-TypeScript App with Redux & Tailwind CSS
22

3-
## OUTLINE
4-
- [How To Run This Project](#how-to-run-this-project)
5-
- [Version Notes](#version-notes)
6-
- [FAQ: Difference between - npm install & npm ci](#faq-difference-between-npm-install--npm-ci)
7-
- [Description of Folder Structure](#description-of-folder-structure)
8-
- [How to Create a Similar Project By Yourself](#how-to-create-a-similar-project-by-yourself)
9-
- [How to Dockerize React App (Coming Soon on My Blog)](https://mukitul-islam.blogspot.com/)
3+
## CONTENTS
4+
- [Getting Started with React-TypeScript App with Redux & Tailwind CSS](#getting-started-with-react-typescript-app-with-redux--tailwind-css)
5+
- [CONTENTS](#contents)
6+
- [How To Run This Project](#how-to-run-this-project)
7+
- [Version Notes](#version-notes)
8+
- [FAQ: Difference between `npm install` & `npm ci`](#faq-difference-between-npm-install--npm-ci)
9+
- [Description of Folder Structure](#description-of-folder-structure)
10+
- [Description of Component Rendering Hierarchy](#description-of-component-rendering-hierarchy)
11+
- [How to Create a Similar Project By Yourself](#how-to-create-a-similar-project-by-yourself)
12+
- [Step-1: Command for Creating TypeScript-React App](#step-1-command-for-creating-typescript-react-app)
13+
- [Step-2: Installation Command for Different Packages](#step-2-installation-command-for-different-packages)
14+
- [Step-3: Create Root Reducer](#step-3-create-root-reducer)
15+
- [Step-4: Create Root Epic](#step-4-create-root-epic)
16+
- [Step-5: Create Redux Store](#step-5-create-redux-store)
17+
- [Step-6: Connect Redux-store with App](#step-6-connect-redux-store-with-app)
18+
- [Step-7: Connect BrowserRouter with App](#step-7-connect-browserrouter-with-app)
19+
- [Step-8: Setup Routing of different component](#step-8-setup-routing-of-different-component)
20+
- [Step-9: Backend API integration](#step-9-backend-api-integration)
21+
- [How to Dockerize React App](#how-to-dockerize-react-app)
1022

1123
#
1224

@@ -60,6 +72,29 @@ src
6072
|
6173
|-- utils (helper-functions, constants are here)
6274
```
75+
76+
## Description of Component Rendering Hierarchy
77+
```text
78+
index.html
79+
|
80+
|
81+
index.tsx
82+
|
83+
|
84+
App.tsx
85+
|
86+
|
87+
MainLayout.tsx
88+
(MainLayout renders differnt screen-component as {children}
89+
according to route setup | screen-component
90+
renders sceen specific page-components)
91+
|
92+
|
93+
----------------------------------
94+
| | |
95+
HeaderComponent.tsx {children} FooterComponent.tsx
96+
```
97+
6398
## How to Create a Similar Project By Yourself
6499

65100
### Step-1: Command for Creating TypeScript-React App
@@ -127,4 +162,7 @@ Example: [index.tsx](./src/index.tsx)
127162
Example: [App.tsx](./src/App.tsx)
128163

129164
### Step-9: Backend API integration
130-
You will found fake store api here: [https://fakestoreapi.com/docs](https://fakestoreapi.com/docs)
165+
You will found fake store api here: [https://fakestoreapi.com/docs](https://fakestoreapi.com/docs)
166+
167+
## How to Dockerize React App
168+
Comming soon on my blog: [https://mukitul-islam.blogspot.com/](https://mukitul-islam.blogspot.com/)

0 commit comments

Comments
 (0)