Back to Nx

Examples for the Vite preview server executor

packages/vite/docs/preview-server-examples.md

22.7.11.5 KB
Original Source

project.json:

json
//...
"my-app": {
    "targets": {
        //...
        "preview": {
            "executor": "@nx/vite:preview-server",
            "defaultConfiguration": "development",
            "options": {
                "buildTarget": "my-app:build",
            },
            "configurations": {
                ...
            }
        },
    }
}
bash
nx preview my-app

Examples

Set up a custom port

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 preview target options:

json
//...
"my-app": {
    "targets": {
        //...
        "preview": {
            "executor": "@nx/vite:preview-server",
            "defaultConfiguration": "development",
            "options": {
                "buildTarget": "my-app:build",
                "port": 4200,
            },
            "configurations": {
                ...
            }
        },
    }
}
Specify a proxyConfig

You can specify a proxy config by pointing to the path of your proxy configuration file:

json
//...
"my-app": {
    "targets": {
        //...
        "preview": {
            "executor": "@nx/vite:preview-server",
            "defaultConfiguration": "development",
            "options": {
                "buildTarget": "my-app:build",
                "proxyConfig": "apps/my-app/proxy.conf.json"
            },
            "configurations": {
                ...
            }
        },
    }
}