README.md

OpenXum

An open framework for turn games

Technology

On The Server	On The Client	Development
Express	Bootstrap	Grunt
Jade	Backbone.js	Bower
Mongoose	jQuery
Passport	Underscore.js
Async	Font-Awesome
EmailJS	Moment.js
WebSocket
Easy-captcha
I18n-2
Zombie
Cucumber

Requirements

You need Node.js and MongoDB installed and running.

We use Grunt as our task runner. Get the CLI (command line interface).

$ npm install grunt-cli -g

We use Bower as our front-end package manager. Get the CLI (command line interface).

$ npm install bower -g

We use bcrypt for hashing secrets. If you have issues during installation related to bcrypt then refer to this wiki page.

Installation

$ git clone [email protected]:openxum-team/openxum-nodejs.git && cd ./openxum-nodejs
$ npm install && bower install
$ grunt

Setup

You need a few records in the database to start using the user system.

Run these commands on mongo. Obviously you should use your email address.

use openxum; //your mongo db name

db.admingroups.insert({ _id: 'root', name: 'Root' });
db.admins.insert({ name: {first: 'Root', last: 'Admin', full: 'Root Admin'}, groups: ['root'] });
var rootAdmin = db.admins.findOne();
db.users.save({ username: 'root', isActive: 'yes', email: '[email protected]', roles: {admin: rootAdmin._id} });
var rootUser = db.users.findOne();
rootAdmin.user = { id: rootUser._id, name: rootUser.username };
db.admins.save(rootAdmin);
db.gametypes.insert({name: 'dvonn'});
db.gametypes.insert({name: 'invers'});
db.gametypes.insert({name: 'gipf'});
db.gametypes.insert({name: 'kamisado'});
db.gametypes.insert({name: 'tzaar'});
db.gametypes.insert({name: 'yinsh'});
db.gametypes.insert({name: 'zertz'});

Now just use the reset password feature to set a password.

• http://localhost:3000/login/forgot/
• Submit your email address and wait a second.
• Go check your email and get the reset link.
• http://localhost:3000/login/reset/:email/:token/
• Set a new password.

Login. Customize. Enjoy.