nx/docs/react/api-web/executors/file-server.md
Isaac Mann de1401965a
docs(nxdev): rewrite getting started section (#5139)
* docs(nxdev): rewrite getting started section

* docs(nxdev): revisions

* docs(nxdev): update features section

* docs(nxdev): updates

Co-authored-by: Isaac Mann <isaacplmann+git@gmail.com>
2021-04-01 15:12:52 -04:00

79 lines
969 B
Markdown

# file-server
Serve a web application from a folder
Properties can be configured in workspace.json when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/react/getting-started/nx-cli#running-tasks.
## Properties
### buildTarget
Type: `string`
Target which builds the application
### host
Default: `localhost`
Type: `string`
Host to listen on.
### maxParallel
Type: `number`
Max number of parallel jobs
### parallel
Default: `true`
Type: `boolean`
Build the target in parallel
### port
Default: `4200`
Type: `number`
Port to listen on.
### proxyUrl
Type: `string`
URL to proxy unhandled requests to.
### ssl
Default: `false`
Type: `boolean`
Serve using HTTPS.
### sslCert
Type: `string`
SSL certificate to use for serving HTTPS.
### sslKey
Type: `string`
SSL key to use for serving HTTPS.
### withDeps
Default: `true`
Type: `boolean`
Build the target and all its deps