This repository has been archived and will no longer be actively maintained. The development and maintenance of the project has been moved to a new repository for better management and scalability.
The project is now located at yracnet/vite-plugin under the packages/ssr-build directory.
Please refer to that repository for the latest version and updates.
Thank you for your support and understanding.
Welcome Remix to ViteJS!
I wanted to use the Remix Framework within the ViteJS environment, while keeping the web module imports and HRM (Hot Module Replacement) functionalities. RemixJS comes with a custom server, but this plugin allows you to use the Vite server during development.
yarn add -D vite-plugin-remixThis plugin requires some dependencies to work properly:
yarn add @remix-run/react
yarn add -D @remix-run/dev @remix-run/express @remix-run/server-runtimeIn your vite.config.ts file:
import { defineConfig } from "vite";
import remixPlugin from "vite-plugin-remix";
export default defineConfig({
plugins: [
remixPlugin({
// appDirectory?: "src",
// future: {
// unstable_dev?: false,
// unstable_postcss?: false,
// unstable_tailwind?: false,
// v2_errorBoundary?: false,
// v2_meta?: false,
// v2_normalizeFormMethod?: false,
// v2_routeConvention?: false,
// },
}),
],
});This plugin requires a request handler. Create a handler.ts file in ${appDirectory} (e.g., src/handler.ts):
import { createRequestHandler } from "@remix-run/express";
import express from "express";
// Custom File from vite-plugin-remix
import { build } from "@remix-vite/serverBuild";
let requestHandler = createRequestHandler({
build,
mode: "production",
});
export const handler = express();
const onRender = async (req, res, next) => {
try {
// This FIX is for supporting the base path deployment on the server
req.url = req.originalUrl;
await requestHandler(req, res, next);
} catch (error) {
next(error);
}
};
handler.get("*", onRender);
// TODO: export const run = ()=>{ /*custom server for production*/}In your root.tsx file (e.g., src/root.tsx), you need to use the LiveReload component from @remix-vite/ui:
import { LiveReload, Welcome } from "@remix-vite/ui";
import {
useCatch,
Links,
Meta,
Outlet,
Scripts,
ScrollRestoration,
} from "@remix-run/react";
const Root = () => {
return (
<html lang="en">
<head>
<meta charSet="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<LiveReload /> {/* Placed at the top of the page */}
<Meta />
<Links />
</head>
<body>
<Welcome />
<Outlet />
<ScrollRestoration />
<Scripts />
</body>
</html>
);
};
export default Root;To run the app, use the Vite flow:
yarn run devCheck out the example project in the "example" folder.
- REMIX_CHACHE_DIR: Defined REMIX_CHACHE_DIR for change the cache directory, default value .remix
- Build Project with Plugin
- Optimize Source Code