deathandmayhem/jolly-roger

Jolly Roger

!Jolly Roger

基于Meteor编写的下一代“死亡与混乱”虚拟总部。它使用https://github.com/rackt/react-router进行导航，并使用Collection2提供模式支持。

快速开始

Jolly Roger利用Meteor对https://github.com/lukehoban/es6features的支持（通过http://babeljs.io编译为ES 5）和https://***.github.io/react/。需要至少1.2版本才能支持这些功能。安装Meteor后，只需运行以下命令启动服务器：

bash
meteor

目前，首个用户没有引导流程，需手动创建用户：

js
meteor shell
> Accounts.createUser({email: 'broder@mit.edu', password: 'password'})
'WaoEku3wBrWLLc7pK'

可能还需要将自己设为管理员：

js
> Roles.addUserToRoles('WaoEku3wBrWLLc7pK', 'admin')

架构组织

Jolly Roger主要为客户端应用结构。服务器主要执行身份验证（以及写入授权），其他情况下主要暴露Meteor的MongoDB接口供客户端直接使用。服务器不对数据访问进行授权——任何已认证用户均可查询任何应用模型。

代码风格

本项目采用https://github.com/airbnb/javascript。虽非完美，但它是较现代的预设之一，至少能确保一定的一致性。项目包含http://eslint.org/配置文件。可以（且应该）通过以下命令检查代码：

bash
meteor npm run lint

数据模型

所有Jolly Roger数据库模型均定义了模式以确保合理性。每个模型应使用SimpleSchema的https://github.com/aldeed/meteor-simple-schema#combining-simpleschemas支持，包含Schemas.Base模式，该模式添加了createdAt和updatedAt等标准化字段。

（Models下的）集合对象均应为Models.Base（或其子类）的实例。基础模型自动设置基于角色的修改系统。

但Models.Base实例不会自动发布。可调用model.publish()进行发布。可选择传递一个函数修改查询以添加额外限制，例如Models.Puzzles将hunt查询项限制为用户所属的hunt。

角色管理

Jolly Roger引入nicolaslopezj的roles包用于权限管理。角色自动添加到模型以控制修改。模板和其他代码应考虑角色因素，但实际上我们可能主要使用管理员角色控制几乎所有权限。

Google集成

Jolly Roger使用Google Spreadsheets作为每个谜题的协作文档，并在创建谜题时自动配置。（这有助于解决手动创建文档的权限问题等。）

要访问Google API，首先需从https://console.developers.google.com/apis/api/drive.googleapis.com/overview启用Google Drive API支持（点击顶部附近的“启用”按钮）。然后需要创建Google OAuth客户端ID。从https://console.developers.google.com/apis/credentials创建新的OAuth客户端ID。如果本地开发（通过localhost），选择“其他”；否则选择“Web应用”。获取客户端ID后，在Meteor shell中运行以下命令存储：

js
> ServiceConfiguration.configurations.upsert({service: 'google'}, {
    $set: {
      clientId: '客户端ID',
      secret: '密钥',
      loginStyle: 'popup',
    },
  })

完成后，手动导航至/setup（例如http://localhost:3000/setup%EF%BC%89%E3%80%82%E4%BB%8E%E9%82%A3%E9%87%8C%EF%BC%8C%E5%8F%AF%E5%B0%86%E8%B4%A6%E6%88%B7%E9%93%BE%E6%8E%A5%E5%88%B0OAuth%E5%BA%94%E7%94%A8%EF%BC%8C%E6%8E%88%E4%BA%88Jolly Roger代表该账户创建文档的权限。

（生产环境中，我们有一个专用Google账户，同时拥有OAuth应用和Drive凭证）