@analogjs/vite-plugin-nitro

A lightweight Vite plugin for integrating with Nitro to enable:

Runtime Server Side Rendering
Build-time Pre-rendering
Static Site Generation
API routes
Sitemaps

Install

npm install @analogjs/vite-plugin-nitro --save-dev

Setup

Add the nitro plugin to the plugins array in the Vite config.

// vite.config.ts
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import nitro from '@analogjs/vite-plugin-nitro';

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    react(),
    nitro({
      ssr: true,
      entryServer: 'src/main.server.tsx',
      prerender: {
        routes: ['/'],
      },
    }),
  ],
});

SSR Setup

Define a src/main.server.ts(x) file to declare how to render the application on the server.

Below is a minimal example for SSR w/React:

import React from 'react';
import ReactDOMServer from 'react-dom/server';

import App from './App';

export default async function render(_url: string, document: string) {
  const html = ReactDOMServer.renderToString(
    <React.StrictMode>
      <App />
    </React.StrictMode>,
  );
  return document.replace('<!--app-html-->', html);
}

Also setup the placeholder to be replaced in the index.html:

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Vite + React + Nitro</title>
  </head>
  <body>
    <div id="root"><!--app-html--></div>
    <script type="module" src="/src/main.tsx"></script>
  </body>
</html>

API Routes

API routes are defined in the src/server/routes/api folder. API routes are also filesystem based, and are exposed under the default /api prefix.

// src/server/routes/api/v1/hello
import { defineEventHandler } from 'h3';

export default defineEventHandler(() => ({ message: 'Hello World' }));

The API route can be accessed as /api/v1/hello.

Custom Source Root Directory

By default, the src folder is used as the path for the discovery of server files and API routes. You can customize the folder with the sourceRoot option.

// vite.config.ts
import { defineConfig } from 'vite';
import nitro from '@analogjs/vite-plugin-nitro';

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    nitro({
      ssr: true,
      entryServer: 'app/main.server.tsx',
      sourceRoot: 'app',
    }),
  ],
});

With this configuration, API routes are discovered under the app/server/routes/api directory. You can also make the it optional by setting the sourceRoot to '.';

Examples

React: https://github.com/brandonroberts/vite-nitro-react
SolidJS: https://github.com/brandonroberts/vite-nitro-solid
Vue: https://github.com/brandonroberts/vite-nitro-vue

Community

Visit and Star the GitHub Repo
Join the Discord
Follow us on Twitter and Bluesky
Become a Sponsor