forked from bimovidia/planning-poker
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
188 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,8 @@ | ||
source 'https://rubygems.org' | ||
|
||
gem 'rails', '4.0.2' | ||
gem 'thin' | ||
gem 'faye' | ||
|
||
# Assets | ||
gem 'jquery-rails' | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
# Pivotal Tracker: Planning Poker | ||
|
||
Planning poker, also called Scrum poker, is a consensus-based technique for estimating, mostly used to estimate effort or relative size of user stories in software development. In planning poker, members of the group make estimates by playing numbered cards in the app, instead of speaking them aloud. The cards are revealed, and the estimates are then discussed. By hiding the figures in this way, the group can avoid the cognitive bias of anchoring, where the first number spoken aloud sets a precedent for subsequent estimates. | ||
|
||
## Features | ||
* Authentication from Pivotal Tracker | ||
* Displays all user's projects in Pivotal Tracker | ||
* Push Notifications when playing cards | ||
* Bootstrap + Font-Awesome for responsive design | ||
|
||
## Dependencies | ||
* Ruby 2.0.0 or later | ||
* MongoDB | ||
* Twitter Bootstrap | ||
* Font-Awesome | ||
* Pivotal Tracker gem (currently v3) | ||
* Thin webserver for Faye | ||
* Faye for Push Notifications | ||
|
||
## Frameworks | ||
This application uses the following frameworks: | ||
|
||
* [Ruby on Rails](http://rubyonrails.org/) (4.0.2) | ||
* [Twitter Bootstrap](http://twitter.github.com/bootstrap/) (Front-end) | ||
* [jQuery](http://jquery.com/) (Javascript) | ||
|
||
## Gems | ||
This application uses the following gems: | ||
|
||
* [Pivotal Tracker](https://github.com/jsmestad/pivotal-tracker) (Pivotal Tracker gem) | ||
* [Faye](http://faye.jcoglan.com/) (Faye) | ||
* [Mongoid](https://github.com/mongoid/mongoid) (Mongoid) | ||
* [Twitter Bootstrap SASS](https://github.com/twbs/bootstrap-sass) (Twitter Bootstrap port to SASS) | ||
* [Font-Awesome](https://github.com/bokmann/font-awesome-rails) (Font-Awesome Rails) | ||
* [BackTop](https://github.com/bimovidia/backtop) (Back To Top functionality) | ||
|
||
## Getting Started | ||
|
||
Planning Poker uses MongoDB as its database. To install it, please refer to the following link: | ||
|
||
* [Install MongoDB](http://docs.mongodb.org/manual/installation/) - MongoDB installation tutorial | ||
* [Mongoid](http://mongoid.org/en/mongoid/index.html) - Mongoid official website for documentations | ||
|
||
Planning Poker uses push notification with Faye. There are configuration files for each environments in config/environments: | ||
|
||
config.publisher = { | ||
# production faye server - change the URL so that it points to the correct server. | ||
domain: 'localhost:9292', | ||
# secret key | ||
secret: 'secret' | ||
} | ||
|
||
Change the domain into the actual production domain when deploying the app. You might want to change the secret key as well. | ||
|
||
To get started, clone this repository to your local machine, and install dependencies: | ||
|
||
```shell | ||
git clone [email protected]:bimovidia/planning-poker.git | ||
cd planning-poker | ||
bundle install | ||
``` | ||
|
||
Open a new terminal and start the faye server: | ||
|
||
```shell | ||
rackup faye.ru -s thin -E production -p 9292 | ||
``` | ||
|
||
Run the application locally with: | ||
|
||
```shell | ||
rails s | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions are encouraged. You can contribute in many ways. For example, you might: | ||
|
||
* add documentation and "how-to" articles to the README or Wiki | ||
* create an extension that provides additional functionality above and beyond Planning Poker itself | ||
* fix bugs you've found in the Issue Tracker or improve / add new features to Planning Poker | ||
|
||
When contributing, you will need to: | ||
|
||
* follow git flow procedure | ||
* follow the same style / convention used throughout the app (as much as you can) | ||
* make sure your codes are well-tested and reviewed | ||
* when fixing a bug, provide a failing test case that your patch solves | ||
* provide proper documentation when necessary | ||
|
||
## Questions? | ||
If you have questions or comments regarding this application, feel free to ask the following people: | ||
|
||
* Bimo Wijoyo **[email protected]** |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,40 @@ | ||
# Files in the config/locales directory are used for internationalization | ||
# and are automatically loaded by Rails. If you want to use locales other | ||
# than English, add the necessary files in this directory. | ||
# | ||
# To use the locales, use `I18n.t`: | ||
# | ||
# I18n.t 'hello' | ||
# | ||
# In views, this is aliased to just `t`: | ||
# | ||
# <%= t('hello') %> | ||
# | ||
# To use a different locale, set it with `I18n.locale`: | ||
# | ||
# I18n.locale = :es | ||
# | ||
# This would use the information in config/locales/es.yml. | ||
# | ||
# To learn more, please read the Rails Internationalization guide | ||
# available at http://guides.rubyonrails.org/i18n.html. | ||
|
||
en: | ||
hello: "Hello world" | ||
all: "All" | ||
cancel: "Cancel" | ||
editable: "Editable" | ||
na: "N/A" | ||
owner: "Owner" | ||
reset: "Reset" | ||
requester: "Requester" | ||
reveal: "Reveal" | ||
save: "Save" | ||
signout: "Sign Out" | ||
story: "Story" | ||
unestimated: "Unestimated" | ||
|
||
projects: | ||
id: "Project ID" | ||
info: "Project Info" | ||
labels: "Project Labels" | ||
more: "More Project(s)" | ||
name: "Project Name" | ||
scheme: "Project Scheme" | ||
scale: "Project Point Scale" | ||
|
||
stories: | ||
id: "Story ID" | ||
type: "Story Type" | ||
points: "Story Points" | ||
state: "Story State" | ||
|
||
# Flashes | ||
flashes: | ||
sessions: | ||
destroy: "You have successfully logged out" | ||
expired: "Your session has expired" | ||
failed: "Invalid username or password" | ||
signin: "You will need to sign in first" | ||
success: "You have successfully logged in" | ||
|
||
stories: | ||
update: "Story ID#%{id} has been updated successfully" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
require 'faye' | ||
|
||
Faye::WebSocket.load_adapter('thin') | ||
|
||
bayeux = Faye::RackAdapter.new(:mount => '/faye', :timeout => 25) | ||
run bayeux |