<a href="https://github.com/Tencent/cloudbase-framework/tree/master/packages/framework-plugin-nuxt">![Tencent CloudBase Framework Nuxt SSR Plugin](https://main.qcloudimg.com/raw/6d48ab8bc29c38558cd258b28b14f94e.jpg)</a>

# Tencent CloudBase Framework Nuxt SSR Plugin

[![Github License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
[![Npm version](https://img.shields.io/npm/v/@cloudbase/framework-plugin-nuxt)](https://www.npmjs.com/package/@cloudbase/framework-plugin-nuxt)
[![issue](https://img.shields.io/github/issues/Tencent/cloudbase-framework)](https://github.com/Tencent/cloudbase-framework/issues)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/cloudbase-framework/pulls)
[![star](https://img.shields.io/github/stars/Tencent/cloudbase-framework?style=social)](https://github.com/Tencent/cloudbase-framework)

**云开发 CloudBase Framework 框架「Nuxt SSR」插件**： 通过云开发 **[CloudBase Framework](https://github.com/Tencent/cloudbase-framework)** 框架将 Nuxt SSR 应用一键部署到云开发环境，提供自动弹性伸缩的高性能 Node SSR 应用服务。可以搭配其他插件如 Website 插件、函数插件实现云端一体开发。

## 功能特性

- 无须关心底层架构: 只需要开发业务服务，不用适配函数或者容器
- 节约成本: 资源伸缩，弹性扩缩容，灵活计费，极大节约资源成本
- 框架支持: 无缝支持 Nuxt 框架构建的项目

## 使用方法

### 步骤一. 准备工作

具体步骤请参照 [准备云开发环境和 CloudBase CLI 命令工具](../../CLI_GUIDE.md)

### 步骤二. 进入 Nuxt 项目目录进行初始化

如果目前已有 Nuxt 应用项目

```bash
cloudbase
```

如果想全新开始一个项目，可以直接执行 init 来从模板开始一个项目

```bash
cloudbase init
```

### 步骤三. 一键部署

```bash
cloudbase framework deploy
```

## 配置

默认情况下不需要任何配置即可使用，以下配置参数针对有特殊需求的场景

### 配置示例

`cloudbase init` 之后会创建云开发的配置文件 `cloudbaserc.js`，可在配置文件的 plugins 里 写入插件配置

```json
{
  "envId": "{{envId}}",
  "framework": {
    "plugins": {
      "client": {
        "use": "@cloudbase/framework-plugin-nuxt",
        "inputs": {
          "entry": "./",
          "path": "/nuxt-ssr",
          "name": "nuxt-ssr",
          "installCommand": "npm install",
          "buildCommand": "npm run build",
          "memory": 512
        }
      }
    }
  }
}
```

### `entry`

默认 `./`

Nuxt 配置文件所在目录，默认当前项目所在目录

### `path`

访问子路径，如 `/nuxt-ssr`

### `name`

服务名，如`nuxt-ssr`

### `installCommand`

安装命令，如`npm install`，没有可不传

默认值 `npm install`

### `buildCommand`

构建命令，如`npm run build`，没有可不传

### `runtime`

云函数运行时版本，选填，默认值 "Nodejs10.15"，可选值 'Nodejs10.15' | 'Nodejs8.9'

### `memory`

云函数运行时内存配置，选填，默认为 256，可选值 128 | 256 | 512 | 1024 | 2048

### `timeout`

函数超时时间（1 - 60S），选填

### `envVariables`

选填，环境变量键值对，会注入运行时的环境变量，环境变量值只能为字符串格式

## 更多插件

请访问 [CloudBase Framework 插件列表](https://github.com/Tencent/cloudbase-framework#%E7%9B%AE%E5%89%8D%E6%94%AF%E6%8C%81%E7%9A%84%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8) 搭配使用其他插件

## 文档资料

- 云开发官网地址： [https://cloudbase.net/](https://cloudbase.net/)
- 云开发静态网站开通指南：[https://docs.cloudbase.net/hosting/](https://docs.cloudbase.net/hosting/)
- 云开发控制台地址： [https://console.cloud.tencent.com/tcb](https://console.cloud.tencent.com/tcb?tdl_anchor=github&tdl_site=0)
