You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/README.md
+13-9Lines changed: 13 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -53,10 +53,6 @@ _Before_ beginning development, especially on teams, make sure to configure your
53
53
54
54
Here are some notes on the current state of Reactime and considerations for future development.
55
55
56
-
## Testing
57
-
58
-
For Reactime unit tests, pre-v.19 there were tests built out in two places. Backend tests were in backend >\_\_tests\_\_. Frontend tests were in src > app >\_\_tests\_\_. In v19, we specifically focused on rebuilding front tests to use React Testing Library (RTL) + Jest. Previously, front end testing existed but utilized Enzyme + Jest . Our decision to move to RTL stemmed on the fact that Enzyme did not support React V17 (third party Enzyme adaptor libraries were created to provide support to previous React versions, but were still very much out of date) and that Enzyme is no longer industry standard. We began the process of creating new frontend tests but they are not complete and this is a great place for future iterators to build out more. Since the new suite of RTL tests are not fully complete, we have kept the older Enzyme tests within the codebase to be referenced (src > app > **tests**enzyme). However, these will not be included in the tests run in the testing scripts.
59
-
60
56
## Including Support for Hooks Beyond useState
61
57
62
58
Reactime currently shows data stored via useState, but does not show data stored via other hooks such as useContext or useReducer. While showing this data would be simple, maintaining the time travel functionality of Reactime with these hooks would not. _Please see file demo-app/src/client/Components/ButtonsWithMoreHooks.jsx for more details._
@@ -74,11 +70,11 @@ Any changes to console.logs in Reactime can be seen by refreshing the browser th
74
70
75
71
## Replace Functionality for Outdated Packages
76
72
77
-
Packages emotion/core and material-ui/core haven't been updated to use React 18. This is the reason npm install --force is necessary when installing the dependencies of Reactime. Replacing the functionality these packages perform and removing them from Reactime would ensure compatibility moving forward.
73
+
Material-ui/core hasn't been updated to use React 18. This is the reason npm install --force is necessary when installing the dependencies of Reactime. Replacing the functionality this package performs and removing it from Reactime would ensure compatibility moving forward.
78
74
79
-
React Developer Tools has deprecated \_\_REACT_DEVTOOLS_GLOBAL_HOOK\_\_, which Reactime uses to extract a running application's fiber tree. At the time of the release of Reactime 19 (May 2023), this tool still works reliably to deliver said fiber tree. This will likely be the case until the React version (React version 18.2 at time of writing) undergoes updates that diverge beyond compatibility with \_\_REACT_DEVTOOLS_GLOBAL_HOOK\_\_. At this time, Reactime will need to change how it extracts an application's fiber tree.
75
+
React Developer Tools has deprecated \_\_REACT_DEVTOOLS_GLOBAL_HOOK\_\_, which Reactime uses to extract a running application's fiber tree. At the time of the release of Reactime 20 (June 2023), this tool still works reliably to deliver said fiber tree. This will likely be the case until the React version (React version 18.2 at time of writing) undergoes updates that diverge beyond compatibility with \_\_REACT_DEVTOOLS_GLOBAL_HOOK\_\_. At this time, Reactime will need to change how it extracts an application's fiber tree.
80
76
81
-
Changing how Reactime extracts the fiber tree before said React version update may yeild diminishing result, as whatever method will also need to be updated to match React's breaking updates.
77
+
Changing how Reactime extracts the fiber tree before said React version update may yield diminishing result, as whatever method will also need to be updated to match React's breaking updates.
82
78
83
79
## Redux
84
80
@@ -94,7 +90,6 @@ In the _src_ folder, there are three directories we care about: _app_, _backend_
94
90
src/
95
91
├── app/ # Frontend code
96
92
│ ├── __tests__/ # React Testing Library
97
-
│ ├── __tests__enzyme/ # Legacy Enzyme tests
98
93
│ ├── actions/ # Redux action creators
99
94
│ ├── components/ # React components
100
95
│ ├── constants/ #
@@ -127,7 +122,6 @@ src/
127
122
│ ├── index.ts # Starting point for backend functionality
128
123
│ ├── index.d.ts # Definitely Type file for Index
129
124
│ ├── module.d.ts #
130
-
│ ├── package.json #
131
125
│ ├── puppeteerServer.ts #
132
126
│
133
127
├── extension/ # Chrome Extension code
@@ -237,8 +231,18 @@ Some relevant sections are reproduced below:
237
231
2. The chrome extension "front-end" **(_NOT_ the interface of the browser, this is an important distinction.)**
238
232
- In other words, a background script works as a sort of middleman, directly maintaining connection with its parent extension, and acting as a proxy enabling communication between it and the content script.
239
233
234
+
# Launching to Chrome Web Store
235
+
236
+
Once you are ready for launch, follow these steps to simplify deployment to the Chrome Web Store:
237
+
238
+
1. Run npm run build in Reactime to build the production version of Reactime
239
+
2. Right click on the build folder and click “compress” to make a compressed zip version of the build folder. The compressed zip is what you will upload to the Chrome Web Store
240
+
3. Navigate to the Chrome Web Store Developer Dashboard (logged in with Reactime credentials). Go to Build > Package > Upload new package, and when prompted, upload the build.zip file
241
+
4. Update the Store Listing and that’s it! Click “Submit for review” and wait for the Chrome store to process your request
242
+
240
243
# Past Medium Articles for Reference
241
244
245
+
-[Reactime 20: Reactime just keeps getting better!](https://medium.com/@njhuemmer/reactime-just-keeps-getting-better-b37659ff8b71)
242
246
-[Reactime 19: What time is it? It’s still Reactime!](https://medium.com/@minzo.kim/what-time-is-it-its-still-reactime-d496adfa908c)
243
247
-[Reactime 18.0. Better than ever](https://medium.com/@zdf2424/reactime-18-0-better-than-ever-148b81606257)
244
248
-[Reactime v17.0.0: Now with support for the Context API, and a modern UI](https://medium.com/@reactime/reactime-v17-0-0-now-with-support-for-the-context-api-and-a-modern-ui-f0edf9e54dae)
0 commit comments