Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-25 09:37:37 +00:00
Code Issues Projects Releases Wiki Activity
6ec97d0b8e
mitmproxy/web/README.md

38 lines
1.5 KiB
Markdown
Raw Normal View History

update mitmweb dev instructions
2018-03-20 17:33:51 +00:00
# Quick Start
web: major upgrades This commit brings a bunch of under-the-hood mitmweb improvements: - migrate large parts of the codebase to typescript - introduce modern react testing conventions - vendor react-codemirror to silence warnings - use esbuild for both bundles and tests - move from yarn to npm - various fixes across the board
2021-06-20 00:12:59 +00:00
- Install mitmproxy as described in [`../CONTRIBUTING.md`](../CONTRIBUTING.md)
- Run `node --version` to make sure that you have at least Node.js 14 or above. If you are on **Ubuntu <= 20.04**, you
need to
[upgrade](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions).
Clarify web frontend docs (#5055)
2022-01-14 12:00:47 +00:00
- Run `cd mitmproxy/web` to change to the directory with package.json
web: major upgrades This commit brings a bunch of under-the-hood mitmweb improvements: - migrate large parts of the codebase to typescript - introduce modern react testing conventions - vendor react-codemirror to silence warnings - use esbuild for both bundles and tests - move from yarn to npm - various fixes across the board
2021-06-20 00:12:59 +00:00
- Run `npm install` to install dependencies
- Run `npm start` to start live-compilation
- Run `mitmweb` after activating your Python virtualenv (see [`../CONTRIBUTING.md`](../CONTRIBUTING.md)).
Document mitmweb architecture Bug: https://github.com/mitmproxy/mitmproxy/issues/3925
2020-05-18 18:21:23 +00:00
coverage++
2021-03-30 10:12:38 +00:00
## Testing
web: major upgrades This commit brings a bunch of under-the-hood mitmweb improvements: - migrate large parts of the codebase to typescript - introduce modern react testing conventions - vendor react-codemirror to silence warnings - use esbuild for both bundles and tests - move from yarn to npm - various fixes across the board
2021-06-20 00:12:59 +00:00
- Run `npm test` to run the test suite.
[mitmweb] Add "one click resume / accept all" button (#4615) * Add one-click-resume button * Add one-click-resume button * update jest snapshot * update style * Disable forward button when the flow is not intercepted * update jest snapshot * group items in main menu * add layout for quick actions menu Co-authored-by: Maximilian Hils <git@maximilianhils.com>
2021-06-10 12:59:30 +00:00
Document mitmweb architecture Bug: https://github.com/mitmproxy/mitmproxy/issues/3925
2020-05-18 18:21:23 +00:00
## Architecture
There are two components:
- Server: [`mitmproxy/tools/web`](../mitmproxy/tools/web)
- Client: `web`
web: major upgrades This commit brings a bunch of under-the-hood mitmweb improvements: - migrate large parts of the codebase to typescript - introduce modern react testing conventions - vendor react-codemirror to silence warnings - use esbuild for both bundles and tests - move from yarn to npm - various fixes across the board
2021-06-20 00:12:59 +00:00
## Contributing
We very much appreciate any (small) improvements to mitmweb. Please do *not* include the compiled assets in
[`mitmproxy/tools/web/static`](https://github.com/mitmproxy/mitmproxy/tree/main/mitmproxy/tools/web/static)
in your pull request. Refreshing them on every commit would massively increase repository size. We will update these
files before every release.
## Developer Tools
- `npm start` supports live-reloading if you install a matching
[browser extension](http://livereload.com/extensions/).
- You can debug application state using the
[React DevTools](https://reactjs.org/blog/2019/08/15/new-react-devtools.html) and
[Redux DevTools](https://github.com/reduxjs/redux-devtools) browser extensions.
Reference in New Issue Copy Permalink