@nx/vite:dev-server

Starts a dev server using Vite.

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.

project.json:

//...
"my-app": {
    "targets": {
        //...
        "serve": {
            "executor": "@nx/vite:dev-server",
            "defaultConfiguration": "development",
            "options": {
                "buildTarget": "my-app:build",
            },
            "configurations": {
                ...
            }
        },
    }
}
Nx 15 and lower use @nrwl/ instead of @nx/

nx serve my-app

Examples

You can always set the port in your vite.config.ts file. However, you can also set it directly in your project.json file, in the serve target options:

//...
"my-app": {
    "targets": {
        //...
        "serve": {
            "executor": "@nx/vite:dev-server",
            "defaultConfiguration": "development",
            "options": {
                "buildTarget": "my-app:build",
                "port": 4200,
            },
            "configurations": {
                ...
            }
        },
    }
}
Nx 15 and lower use @nrwl/ instead of @nx/

Options playground

Try out this interactive editor of the configuration object. Values are validated as you type and hovering over labels will give you more information.

Examples

These buttons show the config object for specific common tasks.

Options

buildTarget

Required

string

Target which builds the application. Only used to retrieve the configuration as the dev-server does not build the code.

buildLibsFromSource

boolean

Default: true

Read buildable libraries from source instead of building them separately.

proxyConfig

string

Path to the proxy configuration file.