Skip to content

installation.md

Latest commit

 

History

History
53 lines (38 loc) · 1.99 KB

installation.md

File metadata and controls

53 lines (38 loc) · 1.99 KB
Raw

Installation guide

Requirements

  • PHP 8.3 or later.
  • The mbstring PHP extension.
  • Composer 2.x.
  • A consumer-managed Vite 5 or later installation when assets are built or served locally.

The package has no runtime dependency on Yii, Inertia, React, Vue, Foxy, Node.js, or a JavaScript package manager. Its optional HTML rendering API uses the framework-agnostic ui-awesome/html library, which includes ui-awesome/html-helper transitively.

Install the PHP package

composer require php-forge/vite:^0.5

Configure the consuming project

Install Vite and any desired plugins in the application with its chosen JavaScript package manager. The PHP package never modifies package.json, installs Vite, or runs a package manager.

Production resolution requires Vite's client build manifest. Enable it in the application's Vite configuration:

import { defineConfig } from "vite";

export default defineConfig({
  build: {
    outDir: "public/build",
    manifest: ".vite/manifest.json",
    rollupOptions: {
      input: "resources/js/app.js",
    },
  },
});

This configuration writes the manifest to <project-root>/public/build/.vite/manifest.json: build.outDir is relative to the Vite project root, and a string build.manifest value is relative to build.outDir. Pass that resulting absolute filesystem path to ProductionConfiguration.

On Vite 5 and later, manifest: true defaults to the same .vite/manifest.json path. Always pass the concrete path your Vite configuration produces rather than assuming one.

Vite injects its modulepreload polyfill into each HTML entry by default. A non-HTML custom entry must import vite/modulepreload-polyfill itself: this package renders modulepreload assets but does not provide the polyfill.

← Back to documentation