forked from ChromeDevTools/devtools-frontend
-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updating README to have more background, example usage, and more detailed installation instructions #119
Closed
+24
−0
Closed
Updating README to have more background, example usage, and more detailed installation instructions #119
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d65681b
README has more detailed description and installation instructions
maxlindbergh 05d4ca5
Update README.md to have example usage
maxlindbergh 90030d0
Fix headings
maxlindbergh f4973bb
Merge branch 'facebookexperimental:main' into main
maxlindbergh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,8 +2,22 @@ | |
|
||
Source code for React Native's debugger frontend, based on Chrome DevTools. This project is periodically compiled and checked into the React Native repo as [`@react-native/debugger-frontend`](https://github.com/facebook/react-native/tree/main/packages/debugger-frontend). | ||
|
||
This project provides the source code for React Native's debugging frontend, which is based on Chrome DevTools. It | ||
enables developers working on React Native apps to debug their code more efficiently by leveraging Chrome DevTools functionality. | ||
|
||
This repository is a fork of [ChromeDevTools/devtools-frontend](https://github.com/ChromeDevTools/devtools-frontend). | ||
|
||
## Example usage | ||
After building the project, you can use the React Native Debugger frontend to inspect and debug your React Native app. First, serve the built files | ||
locally using: | ||
|
||
```sh | ||
python3 -m http.server 8000 --directory out/Default/gen/front_end | ||
``` | ||
Then, open your browser and navigate to http://localhost:8000/inspector.html for general debugging, or http://localhost:8000/rn_inspector.html for | ||
React Native-specific debugging. This allows you to inspect UI components, monitor network requests, and analyze performance metrics directly in | ||
your browser using Chrome DevTools. | ||
|
||
## Development | ||
|
||
### Initial setup | ||
|
@@ -21,18 +35,28 @@ This repository is a fork of [ChromeDevTools/devtools-frontend](https://github.c | |
|
||
1. Build continuously with a file watcher: | ||
|
||
This option continuously rebuilds the project whenever a file changes. It's best suited for active development as it allows you to see changes | ||
in real time, but it can consume more system resources, especially in larger projects. Use this during iterative work when you need fast | ||
feedback. | ||
|
||
```sh | ||
npm run watch | ||
``` | ||
|
||
1. Build with the default config once: | ||
|
||
This single, non-watched build compiles the project with the default configuration. It’s quicker and less resource-heavy than the watch build, | ||
making it ideal for testing changes without long-term commitment to resource usage. | ||
|
||
```sh | ||
npm run build | ||
``` | ||
|
||
1. Build with the release config once: | ||
|
||
This one-time build optimizes the code for production use. It’s slower to compile and can take significantly more time but results in a stable, | ||
high-performance version suitable for production environments. Use this when preparing the project for final deployment or release. | ||
|
||
Comment on lines
+38
to
+59
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These bits feel too verbose (AI generated?) — for the target audience, these scripts are self-documenting. Intend to come back and merge this PR, but let's do a pass of the file which removes these. |
||
```sh | ||
npm run build-release | ||
``` | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.