Skip to content

Commit 2c9be9e

Browse files
MarkTeetsjasnoominzo-kimyuanjackie1
committed
dev readme styled correctly and asset update
Co-authored-by: Jasmine Noor <[email protected]> Co-authored-by: Minzo Kim <[email protected]> Co-authored-by: Jackie Yuan <[email protected]>
1 parent 8ba1231 commit 2c9be9e

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

assets/frontend-diagram.png

12 KB
Loading

src/README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Brief
44

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. 🏃🏾💨
66

77
## Building from source
88

@@ -41,18 +41,18 @@ Similar approach for Next.js and Remix demo apps
4141
- Select “Load Unpacked”
4242
- Choose reactime > src > extension > build
4343
- Navigate to http://localhost:8080/ to inspect the demo application using Reactime!
44-
<br>
4544

46-
<p align="center">
47-
<img src="./assets/reactime-dev-setup.gif" />
48-
</p>
45+
## Linting
4946

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. &nbsp;
48+
&nbsp;
49+
50+
# Possible Avenues for Future Iterators
5151
Here are some notes on the current state of Reactime and considerations for future development.
5252

53-
<h2> Testing </h2>
53+
## Testing
5454

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.
5656

5757
## Including Support for Hooks Beyond useState
5858
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:
6868

6969
Any changes to console.logs in Reactime can be seen by refreshing the browser the app is running in.
7070

71-
7271
## Redux
7372

7473
Can Reactime be integrated with Redux compatibility so applications using Redux can track state in Reactime?
7574

7675
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.
7776

7877

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-
8678
# File Structure
8779

8880
In the _src_ folder, there are three directories we care about: _app_, _backend_, and _extension_.

0 commit comments

Comments
 (0)