Node-Express-Boilerplate 技术文档

1. 安装指南

在开发机上安装本项目，请遵循以下步骤：

• 使用 Git 克隆项目到本地：git clone https://github.com/mape/node-express-boilerplate myproject
• 进入项目目录：cd myproject
• 使用 npm 安装依赖：npm install
• 将样本配置文件复制为配置文件：cp siteConfig.sample.js siteConfig.js
• 使用文本编辑器打开并更新配置文件：mate siteConfig.js
• 运行 nodemon server.js 启动服务

在 no.de 上安装本项目，请执行以下步骤：

在 no.de 服务器上：

• 连接到你的 no.de 服务器：ssh [e-mail]
• 更新并安装 Redis：pkgin update; pkgin install redis
• 导入 Redis 服务配置：svccfg import /opt/local/share/smf/manifest/redis.xml
• 启动 Redis 服务：svcadm enable redis

在本地机器上：

• 使用 Git 克隆项目到本地：git clone https://github.com/mape/node-express-boilerplate myproject
• 进入项目目录：cd myproject
• 复制样本配置文件：cp siteConfig.sample.js siteConfig.js
• 编辑配置文件：edit siteConfig.js settings
• 将配置文件复制到服务器：scp siteConfig.js [e-mail]:~
• 添加远程仓库：git remote add joyent [e-mail]:repo
• 推送代码到远程仓库：git push joyent master
• 打开浏览器访问：http://yourname.no.de

2. 项目使用说明

本项目提供了一个干净的开端，同时包含了足够的实用特性，以去除那些可能会让项目在启动前就出轨的冗余任务。以下是项目的主要功能：

• 集成了 socket.io 和 express 会话存储，以便共享数据。
• 提供了预制的钩子，通过 Facebook/Twitter/Github 对用户进行认证。
• 一个 assetmanager，用于连接/混淆/压缩 CSS/JS 资源，使其尽可能小且快速地传输，并使用 MD5 散列实现缓存破坏。
• 当 CSS/JS/模板文件更改时，自动更新浏览器（内联/刷新），以消除所有那些“保存、标签、刷新”的重复操作。
• 在特定用户操作时，向计算机/手机发送 Notifications。
• 在生产/开发环境中提供合理的默认设置。
• 将错误记录到 Airbrakeapp.com，跟踪用户遇到的所有错误。
• 自动将 URL 匹配到模板，无需定义特定路由（例如，访问 /file-name/ 会尝试提供 file-name.ejs 并回退到 index.ejs - 这对于快速静态信息页面很有帮助）。

3. 项目API使用文档

本项目提供的API使用文档目前未在给出的 readme 中定义。通常，您需要查看项目中的 /routes 目录以及任何相关的文档注释或代码注释来获取API的详细信息。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，包括在开发机和 no.de 服务器上的安装步骤。请按照上述步骤进行操作以确保项目正确安装。