Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/janl/rapidftr

RapidFTR streamlines and speeds up the Family Tracing and Reunification process using small handheld devices to collect information.
https://github.com/janl/rapidftr

Last synced: 3 months ago
JSON representation

RapidFTR streamlines and speeds up the Family Tracing and Reunification process using small handheld devices to collect information.

Awesome Lists containing this project

README 

        
RapidFTR



RapidFTR is a mobile application that lets aid workers collect, sort and 

share information about children in emergency situations. RapidFTR is 

specifically designed to streamline and speed up Family Tracing and Reunification 

efforts both in the immediate aftermath of a crisis and during ongoing recovery 

efforts.



RapidFTR allows for quick input of essential data about a child on a mobile phone, 

including a photograph, the child's age, family, health status and location 

information. Data is saved automatically and uploaded to a central database whenever 

network access becomes available. Registered aid workers will be able to create and 

modify entries for children in their care as well as search all existing records in 

order to help distressed parents find information about their missing children.

Because RapidFTR is designed specifically to collect and distribute information about 

children, data security is extremely important.



Initial development is focused on building an API and web interface, with subsequent 

development of on-phone applications for multiple mobile platforms.



Developer Info



We're working with developers from ThoughtWorks on version one of the API and Web 

Interface.  You can get the source code by forking the GitHub repositories. Please 

feel free to comment or contribute however you like:

GITHUB: RapidFTR Repository

GITHUB: RapidFTR BlackBerry Repository



RapidFTR is being developed using Ruby on Rails and CouchDB. Alongside with the 

development of the central system and API, we've also started to develop the BlackBerry 

client. If you've got experience with any of these and want to help, please get in touch.

 



Install & Run RapidFTR on OSX



To get RapidFTR running on your machine while it’s in a dev environment, you’ll need to 

install the following:

CouchDB 
Ruby 1.8.6 / 1.8.7
Gems
Rails 2.3.5
JSON
Cucumber

You’ll also need to ‘pull’ the code from our GitHub Repository: http://github.com/jorgej/RapidFTR

For more details, read the official CouchDB Read Me



How To Install and Run on MAC OSX:



STEP 1:

	Download and install MacPorts
	Download and install CouchDBX



STEP 2:

	Then run these commands from Terminal or Command Line:



	Ruby:
		To check version: ‘ruby -v’
		If it’s not 1.8.7, install it using macports
		‘sudo port install ruby’



	Gems: 
		‘sudo rake gems:install’
		‘sudo port install rb-rubygems’



	Rails:
		‘sudo rake gems:install’



	JSON
		‘sudo gem install json’



	Cucumber:
		‘sudo gem install cucumber’



STEP 3:



	Do this once MacPorts is installed:
	‘sudo port install rb-libxml2 libxml2’
 

STEP 4:



	To install your CouchDB database:
	From the command line, go to the folder where your GitHub repo is stored in and enter these commands:
	‘rake couchdb:create’
	‘rake couchdb:create RAILS_ENV=cucumber’

	Each time a new database is committed to code (this won’t happen often) you’ll have to rerun the ‘rake couchdb:create’ command.



To run RapidFTR:



From the command line, go to the folder where your GitHub repo is and enter this command:
‘./script/server’

Open CouchDBX

in a browser, go to: 
http://localhost:3000/children
http://localhost:3000/users/

CouchDB itself should be running here: http://localhost:5984
You should also be able to see the built-in database admin tool, Futon, here: http://localhost:5984/_utils/



Cucumber & RSPEC Tests:



To run cucumber tests, type in the command line: ‘cucumber’
To run rspec tests, type in the command line: ‘rake spec’



== 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. 



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

link:files/vendor/rails/activerecord/README.html.



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

link:files/vendor/rails/actionpack/README.html.



== Getting Started



1. At the command prompt, start a new Rails application using the rails command

   and your application name. Ex: rails myapp

2. Change directory into myapp and start the web server: script/server (run with --help for options)

3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"

4. Follow the guidelines to start developing your application



== Web Servers



By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails

with a variety of other web servers.



Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is

suitable for development and deployment of Rails applications. If you have Ruby Gems installed,

getting up and running with mongrel is as easy as: gem install mongrel.

More info at: http://mongrel.rubyforge.org



Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or

Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use

FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.



== Apache .htaccess example for FCGI/CGI



# General Apache options

AddHandler fastcgi-script .fcgi

AddHandler cgi-script .cgi

Options +FollowSymLinks +ExecCGI



# If you don't want Rails to look in certain directories,

# use the following rewrite rules so that Apache won't rewrite certain requests

# 

# Example:

#   RewriteCond %{REQUEST_URI} ^/notrails.*

#   RewriteRule .* - [L]



# Redirect all requests not available on the filesystem to Rails

# By default the cgi dispatcher is used which is very slow

# 

# For better performance replace the dispatcher with the fastcgi one

#

# Example:

#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]

RewriteEngine On



# If your Rails application is accessed via an Alias directive,

# then you MUST also set the RewriteBase in this htaccess file.

#

# Example:

#   Alias /myrailsapp /path/to/myrailsapp/public

#   RewriteBase /myrailsapp



RewriteRule ^$ index.html [QSA]

RewriteRule ^([^.]+)$ $1.html [QSA]

RewriteCond %{REQUEST_FILENAME} !-f

RewriteRule ^(.*)$ dispatch.cgi [QSA,L]



# In case Rails experiences terminal errors

# Instead of displaying this message you can supply a file here which will be rendered instead

# 

# Example:

#   ErrorDocument 500 /500.html



ErrorDocument 500 "
Application error
Rails application failed to start properly"



== Debugging Rails



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 127.0.0.1.



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:



  class WeblogController < ActionController::Base

    def destroy

      @weblog = Weblog.find(params[:id])

      @weblog.destroy

      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")

    end

  end



The result will be a message in your log file along the lines of:



  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1



More information on how to use the logger is at http://www.ruby-doc.org/core/



Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:



* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/

* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)



These two online (and free) books will bring you up to speed on the Ruby language

and also on programming in general.



== Debugger



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 'gem install ruby-debug'

Example:



  class WeblogController < ActionController::Base

    def index

      @posts = Post.find(: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

  => "[#nil, \"body\"=>nil, \"id\"=>\"1\"}>,

       #\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"

  >> @posts.first.title = "hello from a debugger"

  => "hello from a debugger"



...and even better is that you can examine how your runtime objects actually work:



  >> f = @posts.first

  => #nil, "body"=>nil, "id"=>"1"}>

  >> f.

  Display all 152 possibilities? (y or n)



Finally, when you're ready to resume execution, you enter "cont"



== Console



You can interact with the domain model by starting the console through script/console.

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.

Passing an argument will specify a different environment, like script/console production.



To reload your controllers and models after launching the console run reload!



== dbconsole



You can go to the command line of your database directly through script/dbconsole.

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 script/dbconsole production.

Currently works for mysql, postgresql and sqlite.



== Description of Contents



app

  Holds all the code that's specific to this particular application.



app/controllers

  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.



app/models

  Holds models that should be named like post.rb.

  Most models will descend from ActiveRecord::Base.



app/views

  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.



app/views/layouts

  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

  layout :default and create a file named default.html.erb. Inside default.html.erb,

  call <% yield %> to render the view using this layout.



app/helpers

  Holds view helpers that should be named like weblogs_helper.rb. These are generated

  for you automatically when using script/generate for controllers. Helpers can be used to

  wrap functionality for your views into methods.



config

  Configuration files for the Rails environment, the routing map, the database, and other dependencies.



db

  Contains the database schema in schema.rb.  db/migrate contains all

  the sequence of Migrations for your schema.



doc

  This directory is where your application documentation will be stored when generated

  using rake doc:app



lib

  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.



public

  The directory available for the web server. Contains subdirectories for images, stylesheets,

  and javascripts. Also contains the dispatchers and the default HTML files. This should be

  set as the DOCUMENT_ROOT of your web server.



script

  Helper scripts for automation and generation.



test

  Unit and functional tests along with fixtures. When using the script/generate scripts, template

  test files will be generated for you and placed in this directory.



vendor

  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.