Skip to content
Browse files

Changes for new-README-more-gitignore-better-Rakefile-rm-temp-file

  • Loading branch information...
1 parent 71c0ffb commit 1c6a330e70abc96bf0de11cf87f1db48e437e1d4 @jasnow jasnow committed
Showing with 119 additions and 234 deletions.
  1. +3 −0 .gitignore
  2. +113 −234 README
  3. +3 −0 Rakefile
  4. 0 tracker_poker.zargo~
3 .gitignore
@@ -1,7 +1,10 @@
@@ -1,261 +1,140 @@
-== Welcome to Rails
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
+repo ::
+heroku ::
-This pattern splits the view (also called the presentation) into "dumb"
-templates that are primarily responsible for inserting pre-built data in between
-HTML tags. The model contains the "smart" domain objects (such as Account,
-Product, Person, Post) that holds all the business logic and knows how to
-persist themselves to a database. The controller handles the incoming requests
-(such as Save New Account, Update Product, Show Post) by manipulating the model
-and directing data to the view.
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in
+Tracker_Poker is a way to automate the planning poker
+meeting on an Agile project using a mobile phone.
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails. You can read more about Action Pack in
+Tracker_Poker is still in early development, so now
+is the time to make your mark on the project.
-== Getting Started
+* TBD
-1. At the command prompt, create a new Rails application:
- <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
-2. Change directory to <tt>myapp</tt> and start the web server:
- <tt>cd myapp; rails server</tt> (run with --help for options)
-3. Go to http://localhost:3000/ and you'll see:
- "Welcome aboard: You're riding Ruby on Rails!"
-4. Follow the guidelines to start developing your application. You can find
-the following resources handy:
+ # Checkout the project
+ $ git clone git://
+ $ cd tracker_project
+ # Install the project dependencies
+ $ gem install bundler
+ # If you do not have postgres installed, use this:
+ $ bundle install --without production
+ # If you do have postgres installed, use this:
+ $ bundle install
-* The Getting Started Guide:
-* Ruby on Rails Tutorial Book:
+ # Set up the development database.
+ $ rake db:migrate
+ # Start the local web server
+ $ rails server
-== Debugging Rails
+ You should then be able to navigate to `http://localhost:3000/` in a web browser.
-Sometimes your application goes wrong. Fortunately there are a lot of tools that
-will help you debug it and get it back on the rails.
-First area to check is the application log files. Have "tail -f" commands
-running on the server.log and development.log. Rails will automatically display
-debugging and runtime information to these files. Debugging info will also be
-shown in the browser on requests from
+ If you wish to host a publicly available copy of Tracker_Poker,
+ the easiest option is to host it on [Heroku](
-You can also log your own messages directly into the log file from your code
-using the Ruby logger class from inside your controllers. Example:
+ # Make sure you have the Heroku gem
+ $ gem install heroku
- class WeblogController < ActionController::Base
- def destroy
- @weblog = Weblog.find(params[:id])
- @weblog.destroy
-"#{} Destroyed Weblog ID ##{}!")
- end
- end
+ # Create your app. Replace APPNAME with whatever you want to name it.
+ $ heroku create APPNAME --stack bamboo-mri-1.9.2
+ # Define where the user emails will be coming from
+ # (This email address does not need to exist)
+ $ heroku config:add
-The result will be a message in your log file along the lines of:
+ # Allow emails to be sent
+ $ heroku addons:add sendgrid:starter
- Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+ # Deploy the first version
+ $ git push heroku master
-More information on how to use the logger is at
+ To deploy it to Heroku, make sure you have a local copy of the
+ project; refer to the previous section for instuctions. Then:
-Also, Ruby documentation can be found at There are
-several books available online as well:
+ # Set up the database
+ $ heroku rake db:setup
-* Programming Ruby: (Pickaxe)
-* Learn to Program: (a beginners guide)
+ Once that's done, you will be able to view your site at
+ ``.
-These two books will bring you up to speed on the Ruby language and also on
-programming in general.
+Tracker_Poker is currently welcoming contributions. If you'd like to help:
-== Debugger
+Here are some general guidelines for contributing:
+* Check the [issue queue] in Pivotal Tracker TBD-URL
+ for a list of the major features which are yet to be implemented.
+ These have the `feature` and `unstarted` labels. If a feature
+ you'd like isn't there, add an issue.
+* If you'd like to take ownership of one of the features, leave a
+ comment on the issue queue indicating that you're working on it.
+* If you'd like to discuss anything about the issue with other
+ developers, do so on the [Emerald Programming Group]
+ ( mailing list.
+* Fork github project:
+* Make your changes on a branch, and use that branch as the base
+ for pull requests.
+* We encourage you try to break changes up into the smallest logical
+ blocks possible. We would prefer to receive many small commits
+ to one large one in a pull request.
+* Feel free to open unfinished pull requests if you'd like to discuss
+ work in progress, or would like other developers to test it.
+* All patches changes need to be covered by tests and should not
+ break the existing tests, unless a current test is invalidated
+ by a code change.
+* Read over documentation.
+* Run `rake test` to check the Rails test suite is green.
+* If you have any questions please post them to the <emerald city> group.
+* Also attend the <emerald city> Saturday classes.
+* **Please put your open source license here.**
+* **If you need help, check out this: **
+for more information about the format used in the file. It is
+called **Restructured Text**.
-Debugger support is available through the debugger command when you start your
-Mongrel or WEBrick server with --debugger. This means that you can break out of
-execution at any point in the code, investigate and change the model, and then,
-resume execution! You need to install ruby-debug to run the server in debugging
-mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
- class WeblogController < ActionController::Base
- def index
- @posts = Post.all
- debugger
- end
- end
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the server window. Here you can do things like:
- >> @posts.inspect
- => "[#<Post:0x14a6be8
- @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
- #<Post:0x14a6620
- @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
- >> @posts.first.title = "hello from a debugger"
- => "hello from a debugger"
-...and even better, you can examine how your runtime objects actually work:
- >> f = @posts.first
- => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
- >> f.
- Display all 152 possibilities? (y or n)
-Finally, when you're ready to resume execution, you can enter "cont".
-== Console
-The console is a Ruby shell, which allows you to interact with your
-application's domain model. Here you'll have all parts of the application
-configured, just like it is when the application is running. You can inspect
-domain models, change values, and save to the database. Starting the script
-without arguments will launch it in the development environment.
-To start the console, run <tt>rails console</tt> from the application
-* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
- made to the database.
-* Passing an environment name as an argument will load the corresponding
- environment. Example: <tt>rails console production</tt>.
-To reload your controllers and models after launching the console run
-More information about irb can be found at:
-== dbconsole
-You can go to the command line of your database directly through <tt>rails
-dbconsole</tt>. You would be connected to the database with the credentials
-defined in database.yml. Starting the script without arguments will connect you
-to the development database. Passing an argument will connect you to a different
-database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
-PostgreSQL and SQLite 3.
-== Description of Contents
-The default directory structure of a generated Ruby on Rails application:
- |-- app
- | |-- assets
- | |-- images
- | |-- javascripts
- | `-- stylesheets
- | |-- controllers
- | |-- helpers
- | |-- mailers
- | |-- models
- | `-- views
- | `-- layouts
- |-- config
- | |-- environments
- | |-- initializers
- | `-- locales
- |-- db
- |-- doc
- |-- lib
- | `-- tasks
- |-- log
- |-- public
- |-- script
- |-- test
- | |-- fixtures
- | |-- functional
- | |-- integration
- | |-- performance
- | `-- unit
- |-- tmp
- | |-- cache
- | |-- pids
- | |-- sessions
- | `-- sockets
- `-- vendor
- |-- assets
- `-- stylesheets
- `-- plugins
- Holds all the code that's specific to this particular application.
- Contains subdirectories for images, stylesheets, and JavaScript files.
- Holds controllers that should be named like weblogs_controller.rb for
- automated URL mapping. All controllers should descend from
- ApplicationController which itself descends from ActionController::Base.
- Holds models that should be named like post.rb. Models descend from
- ActiveRecord::Base by default.
- Holds the template files for the view that should be named like
- weblogs/index.html.erb for the WeblogsController#index action. All views use
- eRuby syntax by default.
- Holds the template files for layouts to be used with views. This models the
- common header/footer method of wrapping views. In your views, define a layout
- using the <tt>layout :default</tt> and create a file named default.html.erb.
- Inside default.html.erb, call <% yield %> to render the view using this
- layout.
- Holds view helpers that should be named like weblogs_helper.rb. These are
- generated for you automatically when using generators for controllers.
- Helpers can be used to wrap functionality for your views into methods.
- Configuration files for the Rails environment, the routing map, the database,
- and other dependencies.
- Contains the database schema in schema.rb. db/migrate contains all the
- sequence of Migrations for your schema.
- This directory is where your application documentation will be stored when
- generated using <tt>rake doc:app</tt>
- Application specific libraries. Basically, any kind of custom code that
- doesn't belong under controllers, models, or helpers. This directory is in
- the load path.
- The directory available for the web server. Also contains the dispatchers and the
- default HTML files. This should be set as the DOCUMENT_ROOT of your web
- server.
- Helper scripts for automation and generation.
- Unit and functional tests along with fixtures. When using the rails generate
- command, template test files will be generated for you and placed in this
- directory.
- External libraries that the application depends on. Also includes the plugins
- subdirectory. If the app has frozen rails, those gems also go here, under
- vendor/rails/. This directory is in the load path.
3 Rakefile
@@ -5,3 +5,6 @@
require File.expand_path('../config/application', __FILE__)
+task :default => :spec
0 tracker_poker.zargo~
No changes.

0 comments on commit 1c6a330

Please sign in to comment.
Something went wrong with that request. Please try again.