Skip to content

FEDX-1146 #61

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.

Sign up for GitHub

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

Draft
dustinlessard-wf wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

FEDX-1146 #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 39 additions & 52 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,45 @@
A simple HTTP proxy for [webdev's serve command][webdev-serve] that adds support
for rewriting certain requests, namely rewriting 404s to instead serve the root
index (`/`).
[![Slack Channel](https://img.shields.io/badge/Support_Channel-Slack-purple)](https://slack.com/app_redirect?channel=support-frontend-dx)
[![Maintainer](https://img.shields.io/badge/maintainer-FEDX-silver)](https://wiki.atl.workiva.net/display/FEF/Frontend+Dev+Experience)
[![Documentation](https://img.shields.io/badge/Additional_Documentation-blue)](https://frontend.workiva.dev)

## Requirements
# webdev_proxy

The latest release of `webdev_proxy` requires the following:
A simple HTTP proxy for [webdev's serve command][webdev-serve] that adds support for rewriting certain requests, namely rewriting 404s to instead serve the root index (`/`). This enables HTML5 routing support for single-page applications during local development.

## Quick Start

### Prerequisites

- Dart SDK `2.11` or later
- `webdev` globally activated at a version in the `>=1.0.1 <3.0.0` range
- Be sure to follow the [installation instructions for webdev][webdev-install]

## Installation

`webdev_proxy` is intended to be ["activated"][pub-global-activate] rather than
installed as a package dependency.
### Installation

```bash
$ dart pub global activate webdev_proxy
dart pub global activate webdev_proxy
```

Learn more about activating and using packages [here][pub-global].

## Usage
### Usage

`webdev_proxy` supports one command: `serve`

To run the default server and proxy:

```bash
webdev_proxy serve
```

To pass arguments to `webdev serve`, e.g. to enable auto-refresh:

```bash
webdev_proxy serve -- --auto=refresh
```

## Documentation

### `webdev_proxy serve`

```
Expand All @@ -36,61 +51,33 @@ Usage: webdev_proxy serve [-- [webdev serve arguments]]
(defaults to on)

Run "webdev_proxy help" to see global options.
```

You may use any of the following options supported by `webdev serve` by passing them after the `--` separator.

webdev serve --help:
====================

Run a local web development server and a file system watcher that rebuilds on changes.

Usage: webdev serve [arguments] [<directory>[:<port>]]...
-h, --help Print this usage information.
-o, --output A directory to write the result of a build to. Or a mapping from a top-level directory in the package to the directory to write a filtered build output to. For example
"web:deploy".
A value of "NONE" indicates that no "--output" value should be passed to `build_runner`.
(defaults to "NONE")

-r, --[no-]release Build with release mode defaults for builders.
--[no-]build-web-compilers If a dependency on `build_web_compilers` is required to run.
(defaults to on)
Note that you can configure the underlying `webdev serve` process by passing any of its supported command-line arguments after the `--` separator.

-v, --verbose Enables verbose logging.
--auto Automatically performs an action after each build:
See the [webdev serve documentation][webdev-serve] for all available options.

restart: Reload modules and re-invoke main (loses current state)
refresh: Performs a full page refresh.
[restart, refresh]
## Development

--chrome-debug-port Specify which port the Chrome debugger is listening on. If used with launch-in-chrome Chrome will be started with the debugger listening on this port.
--[no-]debug Enable the launching of DevTools (Alt + D). Must use with either --launch-in-chrome or --chrome-debug-port.
--hostname Specify the hostname to serve on.
(defaults to "localhost")
### Setup

--[no-]launch-in-chrome Automatically launches your application in Chrome with the debug port open. Use chrome-debug-port to specify a specific port to attach to an already running chrome instance
instead.
Clone the repository and ensure you have the Dart SDK installed.

--log-requests Enables logging for each request to the server.
### Testing

Run "webdev help" to see global options.
```bash
dart test
```

Note that you can configure the underlying `webdev serve` process by passing any
of its supported command-line arguments after the `--` separator.

#### Examples

To run the default server and proxy:
### Building

```bash
$ webdev_proxy serve
dart pub get
```

To pass arguments to `webdev serve`, e.g. to enable auto-refresh:
## Support

```bash
$ webdev_proxy serve -- --auto=refresh
```
For help, questions, or to report issues, reach out via the [#support-frontend-dx](https://slack.com/app_redirect?channel=support-frontend-dx) Slack channel.

[pub-global]: https://dart.dev/tools/pub/cmd/pub-global
[pub-global-activate]: https://dart.dev/tools/pub/cmd/pub-global#activating-a-package
Expand Down
Loading