Erica 技术文档

1. 安装指南

运行环境要求

• Erlang R14B04 或更高版本，需支持 crypto 模块

编译环境要求

• gcc
• rebar
• git
• erlang-src

在 Debian/Ubuntu 系统上安装依赖

sudo apt-get install rebar erlang-src erlang-xmerl erlang-parsetools

在 Fedora 系统上安装依赖

sudo yum install erlang-rebar

下载

• 签名的 发布版 可从 dch 的站点获取。
• Unix 用户需要执行 chmod +x erica 并确保它在您的 PATH 中。
• Windows 用户应使用 erica.cmd 并将其放入您的 %COUCHDB%/bin 目录。

安装

要从源代码安装，您需要从 github 克隆仓库。构建过程中会获取依赖项。

$ git clone git://github.com/benoitc/erica.git

您也可以下载在 下载页面 上提供的最新 tarball:

$ curl -L -O https://github.com/downloads/benoitc/erica/erica-<vsn>.tar.gz

然后构建源代码：

$ cd erica
$ make

然后您可以使用生成的脚本 erica。

要在您的系统上安装，请运行以下命令行：

$ make install

从源仓库升级

当您想从源仓库升级时，运行以下命令：

$ git pull --rebase
$ make upgrade
$ make install

2. 使用说明

快速开始：设计文档

如果您需要创建和管理 CouchDB 设计文档，可以按照以下步骤操作：

# erica create-app
# cd myapp
# erica push myapp

在 myapp 目录中创建视图、展示、列表等。

快速开始：Web 应用程序

要创建一个 Web 应用程序，按照以下模式操作：

# erica create-webapp
# cd myapp
# erica push myapp

这是一个“附件优先”风格的 couchapp。与设计文档相关的任何内容都存放在 _ddoc 中。

更改后，将其推送到您的 CouchDB 节点：

$ erica push http://127.0.0.1:5984/testdb

然后访问以下地址查看结果：

http://127.0.0.1:5984/testdb/_design/myapp/_rewrite/

默认情况下，CouchDB 节点地址是 127.0.0.1:5984，所以如果您想，可以在 push 命令中仅使用数据库名：

$ erica push testdb

3. 项目 API 使用文档

erica 命令的使用方法如下：

# erica command

可用的命令包括：

• push: 将内容推送到 CouchDB
• create-webapp: 创建一个 Web 应用程序
• create-ddoc: 创建一个空白的设计文档
• create-app: 创建一个空白的 couchapp
• create: 使用模板创建应用程序
• init: 初始化 .couchapprc
• clone: 从 CouchDB 克隆一个文档
• browse: 在浏览器中显示 erica
• web: 启动 Web 用户界面
• help: 显示程序选项
• version: 显示版本信息

更多通用选项：

$ erica -h

4. 项目安装方式

请参考“安装指南”部分的内容进行项目安装。具体步骤包括：

1. 确保满足运行环境要求。
2. 下载或克隆项目源代码。
3. 构建项目。
4. 使用 make install 命令安装项目。