Merge pull request #17 from oslabs-beta/readmeUpdate

Readme update

Author: lillwimberly

CHANGE_LOG.md

@@ -6,13 +6,13 @@
 **Version 14.0.0 Changes**
 
 Changes:<br>
-- Added functionalities & improvements:
-  - Add event listeners:
+- Added functionality & improvements:
+  - Event listeners:
     - Added ability to assign event listeners to elements in the bottom customization tab
     - Can name the function on the event or use the default name provided
     - Updates reflected in the code preview render
-  - Live code preview: Bottom tool tabs code preview renderings update immediately and automatically to reflect the state
-  - Converted the notation button into a delete button on the canvas elements and reusable components
+  - Live code preview: Bottom tool tabs code preview box updates immediately and automatically to reflect the latest changes in state
+  - Converted the annotation button into a delete button on the canvas elements and reusable components
   - Code preview render: The formatting for generated code has been corrected for improved readability
 - Major UI changes:
   - Left panel:
@@ -22,18 +22,21 @@ Changes:<br>
     - Retractable feature added
     - Has internal scroll ability in the tabs
     - Resized functionality is stable
-  - Add indicator tabs to each to signify to the user they are there
-  - Canvas container:
+  - Added indicator tabs to each signifying to the user their presence
+  - Canvas container (upper left):
     - Changed the formatting to a center column with readable size and label orientation
     - Standardized the size of components and rate of growth when nesting
   - Tutorial:
-    - Users can now reference tutorials in split-screen mode without the canvas being auto-cleared when going back from the tutorial
+    - Users can now reference tutorials in split-screen mode without the canvas being auto-cleared when going back and forth from the tutorial
 - Bug fixes:
   - Reusable component: The drag-and-drop feature for reusable components is now functioning smoothly and without bugs
 
-What's next:<br>
-
-A note for future contributors:<br>
+Recommendations for Future Enhancements:<br>
+- Add function content in the current event listeners' function skeleton.
+- The code output formatting in generateCode.ts is currently difficult to read, and could be improved for better readability.
+- Currently, the project uses two sets of state management tools: useReducer/useContext and Redux. useReducer/useContext is used for handling the customization state, and Redux for managing the code preview, context manager, and dark mode reducer state. However, there seems to be some confusion around how to integrate these two tools effectively. For instance, both tools are used for managing the code preview state, and changing the useReducer/useContext state would replace the corresponding redux state. Need to clean up the logic and find a solution to solve this issue.
+- Some of the files structure is not accurate (e.g., customizationPanel.tsx is in the containers folder instead of the bottom folder), need to rearrange the file hierarchy.
+- Update packages and resolve package dependency issues.
 
 **Version 13.0.0 Changes**
 

README.md

@@ -28,11 +28,10 @@
 
 
 <p align="center">
-  <img width="1000" src="https://i.imgur.com/Tuyjd4e.png">
+  <img width="1000" src="https://i.imgur.com/jR53ySV.png">
 </p>
 
 
-
 **ReacType** is a rapid prototyping tool built on Electron that allows users _visualize_ their application architecture dynamically, employing a _drag-and-drop canvas display_ and an interactive, _real-time component code preview_ that can be exported as a **React** app for developers employing React component architecture alongside the comprehensive type-checking of **TypeScript**. In other words, **you can draw prototypes and export React / TypeScript code!**
 
 Visit [reactype.io](https://reactype.io/) to learn more about the product.
@@ -56,11 +55,19 @@ Download the latest [release](https://github.com/open-source-labs/ReacType/relea
 
 ## Changes with version 14.0.0
 
-- **Add event listeners**: Users can now add event listeners to elements in the customization tab and view a list of added events. The list can be edited to remove events, and the live code preview will show the events being added and updated.
-- **Delete buttons added**: Delete buttons have been added to canvas components and elements for easier removal. Users can now delete elements or components directly by focusing on them and clicking the delete button.
-- **Live code preview and component tree update**: When users drag-and-drop components and elements, the live code preview and component tree are automatically updated to reflect the changes in real time.
-- **Major UI changes**: The user interface has undergone a major change, including a sliding effect for the left and bottom panels to maximize user visibility. The styling has been unified and the display of canvas hierarchy has been made more prominent for improved clarity.
-- **And more:** See [change log](https://github.com/open-source-labs/ReacType/blob/master/CHANGE_LOG.md) for more details on what was changed from the previous version as well as plans for upcoming features!
+- **Added event listeners**: Users can now add event listeners to elements in the customization tab and view a list of added events. The list can be edited to remove events, and the live code preview will show the events being added and updated.
+- **Delete buttons added**: Delete buttons have been added to canvas components and elements for easier removal. Users can now delete elements or components directly by focusing on them and mouse-clicking the delete button.
+- **Live code preview and component tree update**: When users drag-and-drop components and elements, the live code preview and component tree are automatically updated to reflect the changes in real-time.
+- **Major UI enhancement**: The user interface has undergone a major change, including a sliding effect for the left and bottom panels to maximize user visibility. The styling has been unified and the display of the canvas hierarchy has been made more prominent for improved clarity.
+- **And more:** See [change log](https://github.com/open-source-labs/ReacType/blob/master/CHANGE_LOG.md) for more details on what was changed from the previous versions as well as plans for upcoming features!
+
+## (_New_) File Structure
+
+Here is the main file structure:
+<p align="center">
+  <img width="1000" src="https://i.imgur.com/RdK8QzW.jpg">
+</p>
+Please refer to the link: https://excalidraw.com/#json=JKwzVD5qx6lsfiHW1_pQ9,XJ6uDoehVu-1bsx0SMlC6w for more details.
 
 
 ## Run ReacType using CLI
@@ -72,7 +79,7 @@ Download the latest [release](https://github.com/open-source-labs/ReacType/relea
 ```bash
 npm install
 ```
-- If there's any issue with the installation, try using `--legacy-peer-deps` flag instead.
+- If there is a dependency issue during installation, try switching to Node version v16.0.0 and then install. If the dependency issue still persists, try using the `--legacy-peer-deps` flag instead.
 
 ```bash
 npm install --legacy-peer-deps