Update several ReadMEs

YSHgroup · Aug 27, 2024 · ae1e99e · ae1e99e
1 parent 6e86085
commit ae1e99e
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,10 @@ Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
   - [Live link](https://next-tutorial-yshgroup.vercel.app/)
 
 ### [Angular](https://angular.dev/)
-- `angular-app` is an Angular app including tutorial and kanbanboard page.
+- `angular-app` is an Angular app including:  
+     tutorial (housing)  
+     kanbanboard page  
+     chat page
   - [Git link](https://github.com/YSHgroup/turborepo-best/tree/main/apps/angular-app)
 
   #### Kanbanboard
@@ -68,6 +71,10 @@ Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
     - Utilized Bootstrap library
     - Integrated with express server
 
+  #### Chat app
+    - Websocket client
+    - TODO: [Link](https://socket.io/docs/v4/tutorial/ending-notes#homework)
+
 ### [Node/Express](https://expressjs.com/)
 - `server` is a Node.js & Express server.
   - Composed `kanban` router

diff --git a/apps/angular-app/README.md b/apps/angular-app/README.md
@@ -4,7 +4,8 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
 
 **Includes the following contents:**
 - **Angular tutorial** - Simple app for beginers
-
+- **Kanban Board** - Kanbanboard page developed by angular 18.
+- ****
 
 ## Angular tutorial - House Marketing
 
@@ -13,5 +14,10 @@ Relevant routes:
 ```
 /housing
 /housing/details/:id
+/kanbanboard
+/chatting
 ```
-And to run the json data, run the following command in root level of this app:  `` json-server --watch src/db.json ``
+
+## Relevant
+- And to run the json data, run the following command in root level of this app:  `` json-server --watch src/db.json ``
+- The Kanbanboard and chatting pages work on active servers. (you can find `backend app`)
diff --git a/apps/backend/README.md b/apps/backend/README.md
@@ -1,5 +1,11 @@
 # Server
-- *What is this server?*
+- *What is this server?*  
+    :serves the several routes for the apps in this turobo
+
+## What are here?
+- Kanbanboard backend
+- Simple websocket backend
+- Socket.io server (separately works)
 
 ## How to init this server?
 - *Create app with TS*  
@@ -22,7 +28,7 @@
     2. Configure and define the type for `req.session.user` in types/express-session.d.ts
     
 ## Routers
-    - *Kanban router*
-
+- *Kanban router*
+- *Websocket router*