https://github.com/dongwa/vercel-quasar

deploy quasar with ssr mode in vercel
https://github.com/dongwa/vercel-quasar

deploy quasar quasar-framework ssr vercel

Last synced: 3 days ago
JSON representation

deploy quasar with ssr mode in vercel

• Host: GitHub
• URL: https://github.com/dongwa/vercel-quasar
• Owner: dongwa
• Created: 2022-05-04T13:54:53.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-21T11:30:33.000Z (5 months ago)
• Last Synced: 2024-11-05T16:52:05.275Z (10 days ago)
• Topics: deploy, quasar, quasar-framework, ssr, vercel
• Language: TypeScript
• Homepage:
• Size: 400 KB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# vercel-quasar

Vercel builder for Quasar with SSR enabled

Help you to deploy [Quasar](https://quasar.dev) application on [Vercel](https://vercel.com) in SSR mode

# usage

## 1. change the listen function in your `src-ssr/server.js` file

- return { handler: ssrHandler }

```js

/**

 * The "listenResult" param for the "close()" definition below

 * is what you return here.

 *

 * For production, you can instead export your

 * handler for serverless use or whatever else fits your needs.

 */

export async function listen({ app, port, isReady, ssrHandler }) {

  if (process.env.DEV) {

    await isReady();

    return await app.listen(port, () => {

      if (process.env.PROD) {

        console.log('Server listening at port ' + port);

      }

    });

  } else {

    // in production

    // "ssrHandler" is a prebuilt handler which already

    // waits for all the middlewares to run before serving clients

    // whatever you return here is equivalent to module.exports. = 

    return { handler: ssrHandler };

  }

}

```

## 2. Configure `vercel-quasar` as builder in `vercel.json`

### Add a `vercel.json` file to your project root path

```json

{

  "version": 2,

  "builds": [

    {

      "src": "package.json",

      "use": "vercel-quasar"

    }

  ]

}

```

## 3. Custom build command （Optional!）

### The default build command is `npx quasar build -m ssr`,if you want to use custom it,add a `build:ssr` or `build` script to your package.json

> Note that the priority of `build:ssr` is higher than that of `build`. If `build:ssr` exists, command `build` will not be executed in deploy.

- example

###

```json

{

  "name": "quasar-example",

  "version": "1.0.0",

  "productName": "quasar-example",

  "scripts": {

    "dev": "quasar dev",

    "dev:ssr": "quasar dev -m ssr",

    "build:ssr": "quasar build -m ssr"

  },

  "dependencies": {},

  "devDependencies": {}

}

```