bot-wat 开源项目使用教程

bot-wat 开源项目使用教程

bot-watHi, I'm a messenger bot based on Gary Bernhardt's Wat talk项目地址:https://gitcode.com/gh_mirrors/bo/bot-wat

1. 项目的目录结构及介绍

bot-wat 项目的目录结构如下：

bot-wat/
├── app.js
├── bin/
│   └── www
├── config/
│   └── default.json
├── controllers/
│   └── messenger.js
├── node_modules/
├── package.json
├── public/
│   └── images/
├── routes/
│   └── index.js
├── views/
│   └── index.ejs
└── README.md

目录结构介绍：

• app.js: 项目的入口文件。
• bin/: 包含启动脚本。
• config/: 包含配置文件。
• controllers/: 包含控制器文件，处理业务逻辑。
• node_modules/: 包含项目依赖的模块。
• package.json: 项目的配置文件，包含依赖和脚本。
• public/: 静态文件目录，如图片等。
• routes/: 路由文件，定义URL和处理函数的映射。
• views/: 视图文件，用于渲染页面。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 bin/www，主要内容如下：

#!/usr/bin/env node

/**
 * Module dependencies.
 */

var app = require('../app');
var debug = require('debug')('bot-wat:server');
var http = require('http');

/**
 * Get port from environment and store in Express.
 */

var port = normalizePort(process.env.PORT || '3000');
app.set('port', port);

/**
 * Create HTTP server.
 */

var server = http.createServer(app);

/**
 * Listen on provided port, on all network interfaces.
 */

server.listen(port);
server.on('error', onError);
server.on('listening', onListening);

/**
 * Normalize a port into a number, string, or false.
 */

function normalizePort(val) {
  var port = parseInt(val, 10);

  if (isNaN(port)) {
    // named pipe
    return val;
  }

  if (port >= 0) {
    // port number
    return port;
  }

  return false;
}

/**
 * Event listener for HTTP server "error" event.
 */

function onError(error) {
  if (error.syscall !== 'listen') {
    throw error;
  }

  var bind = typeof port === 'string'
    ? 'Pipe ' + port
    : 'Port ' + port;

  // handle specific listen errors with friendly messages
  switch (error.code) {
    case 'EACCES':
      console.error(bind + ' requires elevated privileges');
      process.exit(1);
      break;
    case 'EADDRINUSE':
      console.error(bind + ' is already in use');
      process.exit(1);
      break;
    default:
      throw error;
  }
}

/**
 * Event listener for HTTP server "listening" event.
 */

function onListening() {
  var addr = server.address();
  var bind = typeof addr === 'string'
    ? 'pipe ' + addr
    : 'port ' + addr.port;
  debug('Listening on ' + bind);
}

启动文件介绍：

• 引入必要的模块：app, debug, http。
• 从环境变量中获取端口，并设置到Express应用中。
• 创建HTTP服务器并监听指定端口。
• 定义错误处理和监听事件的回调函数。

3. 项目的配置文件介绍

项目的配置文件位于 config/default.json，主要内容如下：

{
  "facebook": {
    "pageToken": "YOUR_PAGE_TOKEN",
    "verifyToken": "YOUR_VERIFY_TOKEN"
  },
  "port": 3000
}

配置文件介绍：

• facebook: 包含Facebook Messenger的页面令牌和验证令牌。
• port: 服务器监听的端口号

bot-watHi, I'm a messenger bot based on Gary Bernhardt's Wat talk项目地址:https://gitcode.com/gh_mirrors/bo/bot-wat