Vite-ssr-vue3 NPM

Vite-SSR-Vue3

version

Vite plugin for vue Server-Side Rendering, Used express to create a server.

Usage

Install

# npm
npm install -D vite-ssr-vue3 vue-router

# yarn
yarn add -D vite-ssr-vue3 vue-router

# pnpm
pnpm add -D vite-ssr-vue3 vue-router

# pnpm workspaces
pnpm add -D vite-ssr-vue3 vue-router -F <Repo Name>

Modify package.json scripts to:

{
  "scripts": {
-   "dev": "vite --port 3333",
+   "dev": "vite-ssr --port 3333",
-   "build": "vite build",
+   "build": "vite-ssr build",
+   "serve": "vite-ssr --mode production"
  },
}

// src/main.ts
import { ViteSSR } from 'vite-ssr-vue3'
import routes from './routes'
import App from './App.vue'

// Export `createApp` function is required by vite-ssr
export const createApp = ViteSSR(App, { routes }, (context) => {
  // if (import.meta.env.SSR) {
  //   // Running in server
  // } else {
  //   // Running in browser
  // }
})

Initial State

// src/main.ts
import { ViteSSR } from 'vite-ssr-vue3'
import routes from './routes'
import App from './App.vue'

export const createApp = ViteSSR(App, { routes }, (context) => {
  const { app, initialState } = context

  // Use pinia to store your data
  const pinia = createPinia()

  if (import.meta.env.SSR)
    initialState.pinia = pinia.state.value
  else
    pinia.state.value = initialState.pinia

})

Data Fetching

import { useFetch } from 'vite-ssr-vue3'

const counts = await useFetch('counts', () => Promise.resolve([1, 2, 3]))

Full Control Build

vite-ssr build command default equals build client and server, so you can customize your build process.

{
  "scripts": {
+   "build": "vite-ssr build",
-   "build:client": "vite build --ssrManifest --outDir dist/client",
-   "build:server": "vite build --ssr src/main.ts --outDir dist/server",
  },
}

vite-ssr support separate options for client and server building, Configure them for separate builds

import { defineConfig } from 'vite'

export default defineConfig({
  ssrOptions: {
    // Client build options
    clientConfig: {},
    // Server build options
    serverConfig: {},
  },
})

Compiled with vite-ssr build, there are three ways to start the server:

Run vite-ssr --mode production

Use vite-ssr built-in express server, then run node ./bin/www

// ./bin/www.js
const { startExpressServer: startServer } = require('vite-ssr-vue3/server')
const { createApp } = require('../dist/server/main.cjs')

startServer({ createApp })

Customize server

vite-ssr-vue3/server export a function createRender to allows you create a render function.

// ./src/express.js
// @ts-check
const path = require('path')
const express = require('express')
const { createRender } = require('vite-ssr-vue3/server')

async function createServer() {
  const out = path.join(__dirname, '../dist')
  const resolve = p => path.resolve(out, p)
  const app = express()
  app.use(express.static(resolve('./client'), {
    index: false,
    maxAge: '1y',
  }))

  const render = await createRender({ isProd: true, root: __dirname, outDir: '../dist' })
  const { createApp } = require(resolve('./server/main.cjs'))

  app.use('*', async(req, res) => {
    try {
      const url = req.originalUrl

      if (req.method !== 'GET' || url === '/sw.js' || url === '/favicon.ico')
        return

      const context = await createApp(false)
      let html = await render(url, { context })

      html += '\n<!-- From customize server -->'

      res.status(200).set({ 'Content-Type': 'text/html' }).end(html)
    }
    catch (error) {
      -console.error(error)
      res.status(500).end(error.stack)
    }
  })

  return { server: app }
}

createServer().then(({ server }) =>
  server.listen(3000, () => {
    // eslint-disable-next-line no-console
    console.info('http://localhost:3000')
  }),
)

I three ways, we need to strongly depend on the server, although we can use ssr.noExternal to package dependencies, but the server cannot be packaged in, you must install server package npm install express

we can modify the server building entry file to avoid this, create a new file to wrapper your server instance(vite-ssr will not works), configure ssr.noExternal: /./ to package all dependencies. if you want to runing anywhere, this is recommended.

// src/server.ts
import { startExpressServer as startServer } from 'vite-ssr-vue3/server'
import { createApp } from './main'

startServer({ createApp, root: __dirname, outDir: '..' })

// vite.config.noexternal.ts
import type { UserConfig } from 'vite'
import { defineConfig } from 'vite'

export default defineConfig({
  ssrOptions: {
    serverConfig: {
      build: {
        ssr: './src/server',
      },
      ssr: {
        noExternal: /./,
      },
    },
  },
} as UserConfig)

then run vite-ssr build:noexternal, wait for a while, now you can run node dist/server/server.cjs (Required right path) to start the server anywhere.