Flatiron 项目技术文档

1. 安装指南

1.1 安装 Node Package Manager (NPM)

首先，确保你已经安装了 Node.js 和 NPM。如果没有安装，可以通过以下命令安装 NPM：

curl http://npmjs.org/install.sh | sh

1.2 安装 Flatiron

安装 Flatiron 框架：

[sudo] npm install flatiron

1.3 安装 Union（flatiron.plugins.http 所需）

如果你需要使用 HTTP 插件，还需要安装 Union：

npm install union

2. 项目的使用说明

2.1 创建 HTTP 服务器

Flatiron 提供了简单的方式来创建 HTTP 服务器。以下是一个基本的 HTTP 服务器示例：

var flatiron = require('flatiron'),
    app = flatiron.app;

app.use(flatiron.plugins.http);

app.router.get('/', function () {
  this.res.writeHead(200, { 'Content-Type': 'text/plain' });
  this.res.end('Hello world!\n');
});

app.start(8080);

2.2 创建 HTTPS 服务器

如果你需要创建一个 HTTPS 服务器，可以提供证书和密钥文件：

var flatiron = require('flatiron'),
    app = flatiron.app;

app.use(flatiron.plugins.http, {
  https: {
    cert: 'path/to/cert.pem',
    key: 'path/to/key.pem',
    ca: 'path/to/ca.pem'
  }
});

app.router.get('/', function () {
  this.res.writeHead(200, { 'Content-Type': 'text/plain' });
  this.res.end('Hello world!\n');
});

app.start(8080);

2.3 创建 CLI 应用程序

Flatiron 也可以用于创建命令行应用程序。以下是一个简单的 CLI 应用程序示例：

var flatiron = require('flatiron'),
    app = flatiron.app;

app.use(flatiron.plugins.cli, {
  dir: __dirname,
  usage: [
    'This is a basic flatiron cli application example!',
    '',
    'hello - say hello to somebody.'
  ]
});

app.cmd('hello', function () {
  app.prompt.get('name', function (err, result) {
    app.log.info('hello '+result.name+'!');
  })
})

app.start();

运行该程序：

node example.js hello
prompt: name: world
info:   hello world!

3. 项目 API 使用文档

3.1 flatiron.app

flatiron.app 是一个 Broadway 注入容器，允许插件直接修改 app 对象。以下是一个简单的示例：

var flatiron = require('flatiron'),
    app = flatiron.app;

var hello = {
  attach: function (options) {
    this.hello = options.message || 'Why hello!';
  }
};

app.use(hello, {
  message: "Hi! How are you?"
});

// 输出: "Hi! How are you?"
console.log(app.hello);

3.2 app.config

flatiron.app 自带一个 config 插件，用于配置管理。以下是一些基本用法：

// 添加 `env` 存储
app.config.use('env');

// 添加 `file` 存储
app.config.use('file', { file: 'path/to/config.json' });

// 移除 `literal` 存储
app.config.remove('literal');

3.3 app.log

flatiron.app 在初始化阶段会加载一个 log 插件，该插件将一个 Winston 日志容器附加到 app.log。

4. 项目安装方式

Flatiron 可以通过 NPM 进行安装，具体步骤如下：

1. 安装 NPM：

   curl http://npmjs.org/install.sh | sh
   

2. 安装 Flatiron：

   [sudo] npm install flatiron
   

3. 安装 Union（如果需要使用 flatiron.plugins.http）：

   npm install union
   

通过以上步骤，你就可以成功安装并使用 Flatiron 框架来构建 HTTP 服务器、HTTPS 服务器或 CLI 应用程序。