Plunker 技术文档

2024-12-28 01:01:17作者：袁立春Spencer

本文档将为您详细介绍 Plunker 项目的安装、使用和 API 调用方法。

1. 安装指南

在开始使用 Plunker 之前，您需要确保已经安装了以下依赖：

Node.js
Git

以下是安装 Plunker 的步骤：

# 克隆项目
git clone git://github.com/filearts/plunker.git
cd plunker

# 初始化子模块
git submodule update --init

# 安装依赖
npm install

# 启动服务
node server.js

2. 项目使用说明

在本地启动 Plunker 服务后，您可以通过浏览器访问 http://localhost:8080 来使用 Plunker。

配置文件

每个服务器在本地克隆后都需要一个或两个 config.json 文件才能运行。以下是一些服务器所需的配置文件：

plunker_api、plunker_www、plunker_run、plunker_collab 使用环境特定的配置文件 config.development.json 和 config.production.json。
只有 plunker_embed 使用单个 config.json 文件。

下面是一个配置文件的示例：

{
  "host": "hostname.com",
  "url": {
    "www": "http://hostname.com",
    "collab": "http://collab.hostname.com",
    "api": "http://api.hostname.com",
    "embed": "http://embed.hostname.com",
    "run": "http://run.hostname.com",
    "carbonadsH": "OOPS, this is pretty specific to my current deploy",
    "carbonadsV": "OOPS, this is pretty specific to my current deploy"
  },
  "port": 8080,
  "oauth": {
    "github": {
      "id": "series_of_random_chars",
      "secret": "longer_series_of_random_chars"
    }
  }
}

请根据实际情况修改配置文件中的内容。

3. 项目 API 使用文档

Plunker 提供了一个简单的 API，允许用户通过 POST 请求初始化编辑器。

`POST /edit/`

您可以通过发送 POST 请求到 /edit/ 地址，来引导编辑器加载 Plunk 的基本结构。以下是 JSON 格式的描述：

{
  "description": "Plunk 描述",
  "tags": ["array", "of", "tags"],
  "files": [
    {
      "filename": "index.html",
      "content": "<html><script src=\"script.js\"></script></html>"
    },
    {
      "filename": "script.js",
      "content": "alert('hello world');"
    }
  ]
}