xaiid / planningpoker

TangoSource Poker Estimate

##Description

This project aims to help SCRUM estimation process by using Planning Poker technique It allows to create game sessions for your sprint estimation where you and all of your teammates can participate in real time.

##Requirements

• Node >= 0.10.0

##Getting Started

###Install Dependencies

####Development dependencies

In order to keep our development process high-speed, we are taking advantages of these great tools:

• Grunt
• Bower
• AngularJS Full-Stack Generator

Please install them if you have not done it yet.

$ npm install -g generator-angular-fullstack

$ npm install -g grunt-cli

$ npm install -g bower

We asume that you have some experience with these tools, if not, please take a look on their pages.

####Project dependencies To install all of npm and bower dependencies please run:

$ npm install && bower install

You are ready to run the server with this comand

$ grunt serve

##Development

Since we are using AngularJS Full-Stack Generator development is much easier:

To generate a controller, directive, route, endpoint, service, etc. We do it like this:

yo angular-fullstack:type name

To generate an angular controller for example we run

yo angular-fullstack:controller user

The generator will ask if we want to place it in default path or we can choose another one

This command generates:

client/app/user/user.controller.js
client/app/user/user.controller.spec.js

Since we are using grunt-injector we do not need to require this file our index or layout.

We have our spec file as well, and we are ready to use our user controller. Awesome!

##Tests

Pretty simple commands to run our tests. In order to run integration test please run this command first:

npm run update-webdriver

To run all tests

$ grunt test

To run Integration tests

$ grunt test:e2e

To run unit angular tests

$ grunt test:client

To run unit server tests

$ grunt test:server

##Contribution Guilde lines

Want to contribuite? Great!!

Please fork the project and make a pull request to our repository.

##License

The MIT License (MIT)

Copyright (c)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.