2018-03-20 17:33:51 +00:00
|
|
|
# Quick Start
|
|
|
|
|
|
2020-04-03 14:35:03 +00:00
|
|
|
**Be sure to follow the Development Setup instructions found in the README.md,
|
|
|
|
|
and activate your virtualenv environment before proceeding.**
|
2018-03-20 17:33:51 +00:00
|
|
|
|
|
|
|
|
- Run `yarn` to install dependencies
|
2020-02-21 22:16:02 +00:00
|
|
|
- Run `yarn run gulp` to start live-compilation.
|
2018-03-20 17:33:51 +00:00
|
|
|
- Run `mitmweb` and open http://localhost:8081/
|
2020-05-18 18:21:23 +00:00
|
|
|
|
2021-03-30 10:12:38 +00:00
|
|
|
## Testing
|
|
|
|
|
|
2021-06-09 15:49:04 +00:00
|
|
|
- Run `yarn test` to run the test suite.
|
2021-03-30 10:12:38 +00:00
|
|
|
|
2021-06-10 12:59:30 +00:00
|
|
|
|
|
|
|
|
## Advanced Tools
|
|
|
|
|
|
|
|
|
|
- `yarn run gulp` supports live-reloading if you install a matching
|
|
|
|
|
[browser extension](http://livereload.com/extensions/).
|
|
|
|
|
- You can debug application state using the [Redux DevTools](https://github.com/reduxjs/redux-devtools).
|
|
|
|
|
|
2020-05-18 18:21:23 +00:00
|
|
|
## Architecture
|
|
|
|
|
|
|
|
|
|
There are two components:
|
|
|
|
|
|
|
|
|
|
- Server: [`mitmproxy/tools/web`](../mitmproxy/tools/web)
|
|
|
|
|
|
|
|
|
|
- Client: `web`
|
