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
+8-16Lines changed: 8 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Brief
4
4
5
-
Our mission at Reactime is to maintain and iterate constantly, but never at the expense of future developers.<br />We know how hard it is to quickly get up to speed and onboard in a new codebase.<br />So, here are some helpful pointers to help you hit the ground running. 🏃🏾💨
5
+
Our mission at Reactime is to maintain and iterate constantly, but never at the expense of future developers.We know how hard it is to quickly get up to speed and onboard in a new codebase. So here are some helpful pointers to help you hit the ground running. 🏃🏾💨
6
6
7
7
## Building from source
8
8
@@ -41,18 +41,18 @@ Similar approach for Next.js and Remix demo apps
41
41
- Select “Load Unpacked”
42
42
- Choose reactime > src > extension > build
43
43
- Navigate to http://localhost:8080/ to inspect the demo application using Reactime!
44
-
<br>
45
44
46
-
<palign="center">
47
-
<imgsrc="./assets/reactime-dev-setup.gif" />
48
-
</p>
45
+
## Linting
49
46
50
-
## For Future Iterators
47
+
_Before_ beginning development, especially on teams, make sure to configure your linter and code formatting to conform to one unified setting (We recommend [the Airbnb style guide](https://github.com/airbnb/javascript)!) This will make reviewing PRs much more readable and less error-prone.
48
+
49
+
50
+
# Possible Avenues for Future Iterators
51
51
Here are some notes on the current state of Reactime and considerations for future development.
52
52
53
-
<h2> Testing </h2>
53
+
##Testing
54
54
55
-
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.
55
+
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.
56
56
57
57
## Including Support for Hooks Beyond useState
58
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.
@@ -68,21 +68,13 @@ To see how hook data is stored in the fiber tree:
68
68
69
69
Any changes to console.logs in Reactime can be seen by refreshing the browser the app is running in.
70
70
71
-
72
71
## Redux
73
72
74
73
Can Reactime be integrated with Redux compatibility so applications using Redux can track state in Reactime?
75
74
76
75
Yes, but it would be very time-consuming and not the most feasible option while Redux devtools exists already. With how Redux devtools is currently set up, a developer is unable to use Redux devtools as a third-party user and integrate its functionality into their own application, as Redux devtools is meant to be used directly on an application using Redux for state-tracking purposes. Since the devtools do not appear to have a public API for integrated use in an application or it simply does not exist, Redux devtools would need to be rebuilt from the ground up and then integrated into Reactime, or built into Reactime directly still from scratch.
77
76
78
77
79
-
## Quick Tips
80
-
81
-
-_Before_ beginning development, especially on teams, make sure to configure your linter and code formatting to conform to one unified setting (We recommend [the Airbnb style guide](https://github.com/airbnb/javascript)!) This will make reviewing PRs much more readable and less error-prone.
82
-
83
-
- With release of Node v18.12.1 (LTS) on 11/4/22, the script has been updated to 'npm run dev' | 'npm run build' for backwards compatibility.<br/>
84
-
For version Node v16.16.0, please use script 'npm run devlegacy' | 'npm run buildlegacy'
85
-
86
78
# File Structure
87
79
88
80
In the _src_ folder, there are three directories we care about: _app_, _backend_, and _extension_.
0 commit comments