mirror of
https://github.com/TracksApp/tracks.git
synced 2025-12-20 09:10:12 +01:00
Failed to svn rm the moved documents in previous commit, so removing them properly here.
git-svn-id: http://www.rousette.org.uk/svn/tracks-repos/trunk@704 a4c988fc-2ded-0310-b66e-134b36920a42
This commit is contained in:
bsag
parent
098cf843e3
commit
67c79ba5a6
3 changed files with 0 additions and 251 deletions
|
|
@ -1,23 +0,0 @@
|
|||
1. SQLITE3 FOR TESTING
|
||||
|
||||
By default, tests are configured to run using sqlite3 in memory mode to increase speed. You will need the sqlite3-ruby gem for this.
|
||||
|
||||
To avoid showing the migrations as tests are run, add the following to your database.yml below 'database: ":memory:"':
|
||||
|
||||
verbosity: quiet
|
||||
|
||||
If you want to run tests using another database, that's fine, too. Just change your database.yml accordingly.
|
||||
|
||||
2. SELENIUM TESTS
|
||||
|
||||
To run selenium tests, start Tracks in test mode using
|
||||
|
||||
script/server -e test
|
||||
|
||||
Then open a browser to
|
||||
|
||||
http://localhost:3000/selenium/
|
||||
|
||||
and interact with the test runner.
|
||||
|
||||
For more information about Selenium on Rails, see vendor/plugins/selenium-on-rails/README
|
||||
|
|
@ -1,190 +0,0 @@
|
|||
== Welcome to Rails
|
||||
|
||||
Rails is a web-application and persistance framework that includes everything
|
||||
needed to create database-backed web-applications according to the
|
||||
Model-View-Control pattern of separation. This pattern splits the view (also
|
||||
called the presentation) into "dumb" templates that are primarily responsible
|
||||
for inserting pre-build 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 a 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 is 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.
|
||||
|
||||
|
||||
== Requirements
|
||||
|
||||
* Database and driver (MySQL, PostgreSQL, or SQLite)
|
||||
* Rake[http://rake.rubyforge.org] for running tests and the generating documentation
|
||||
|
||||
== Optionals
|
||||
|
||||
* Apache 1.3.x or 2.x or lighttpd 1.3.11+ (or any FastCGI-capable webserver with a
|
||||
mod_rewrite-like module)
|
||||
* FastCGI (or mod_ruby) for better performance on Apache
|
||||
|
||||
== Getting started
|
||||
|
||||
1. Run the WEBrick servlet: <tt>ruby script/server</tt>
|
||||
(run with --help for options)
|
||||
2. Go to http://localhost:3000/ and get "Congratulations, you've put Ruby on Rails!"
|
||||
3. Follow the guidelines on the "Congratulations, you've put Ruby on Rails!" screen
|
||||
|
||||
|
||||
== Example for Apache conf
|
||||
|
||||
<VirtualHost *:80>
|
||||
ServerName rails
|
||||
DocumentRoot /path/application/public/
|
||||
ErrorLog /path/application/log/server.log
|
||||
|
||||
<Directory /path/application/public/>
|
||||
Options ExecCGI FollowSymLinks
|
||||
AllowOverride all
|
||||
Allow from all
|
||||
Order allow,deny
|
||||
</Directory>
|
||||
</VirtualHost>
|
||||
|
||||
NOTE: Be sure that CGIs can be executed in that directory as well. So ExecCGI
|
||||
should be on and ".cgi" should respond. All requests from 127.0.0.1 goes
|
||||
through CGI, so no Apache restart is necessary for changes. All other requests
|
||||
goes through FCGI (or mod_ruby) that requires restart to show changes.
|
||||
|
||||
|
||||
== Example for lighttpd conf (with FastCGI)
|
||||
|
||||
server.port = 8080
|
||||
server.bind = "127.0.0.1"
|
||||
# server.event-handler = "freebsd-kqueue" # needed on OS X
|
||||
|
||||
server.modules = ( "mod_rewrite", "mod_fastcgi" )
|
||||
|
||||
url.rewrite = ( "^/$" => "index.html", "^([^.]+)$" => "$1.html" )
|
||||
server.error-handler-404 = "/dispatch.fcgi"
|
||||
|
||||
server.document-root = "/path/application/public"
|
||||
server.errorlog = "/path/application/log/server.log"
|
||||
|
||||
fastcgi.server = ( ".fcgi" =>
|
||||
( "localhost" =>
|
||||
(
|
||||
"min-procs" => 1,
|
||||
"max-procs" => 5,
|
||||
"socket" => "/tmp/application.fcgi.socket",
|
||||
"bin-path" => "/path/application/public/dispatch.fcgi",
|
||||
"bin-environment" => ( "RAILS_ENV" => "development" )
|
||||
)
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
== Debugging Rails
|
||||
|
||||
Have "tail -f" commands running on both the server.log, production.log, and
|
||||
test.log files. 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.
|
||||
|
||||
|
||||
== Breakpoints
|
||||
|
||||
Breakpoint support is available through the script/breakpointer client. This
|
||||
means that you can break out of execution at any point in the code, investigate
|
||||
and change the model, AND then resume execution! Example:
|
||||
|
||||
class WeblogController < ActionController::Base
|
||||
def index
|
||||
@posts = Post.find_all
|
||||
breakpoint "Breaking out from the list"
|
||||
end
|
||||
end
|
||||
|
||||
So the controller will accept the action, run the first line, then present you
|
||||
with a IRB prompt in the breakpointer window. Here you can do things like:
|
||||
|
||||
Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
|
||||
|
||||
>> @posts.inspect
|
||||
=> "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
|
||||
#<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
|
||||
>> @posts.first.title = "hello from a breakpoint"
|
||||
=> "hello from a breakpoint"
|
||||
|
||||
...and even better is that 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 press CTRL-D
|
||||
|
||||
|
||||
== 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. Start the script without arguments will launch it in the development environment.
|
||||
Passing an argument will specify a different environment, like <tt>console production</tt>.
|
||||
|
||||
|
||||
== Description of contents
|
||||
|
||||
app
|
||||
Holds all the code that's specific to this particular application.
|
||||
|
||||
app/controllers
|
||||
Holds controllers that should be named like weblog_controller.rb for
|
||||
automated URL mapping. All controllers should descend from
|
||||
ActionController::Base.
|
||||
|
||||
app/models
|
||||
Holds models that should be named like post.rb.
|
||||
Most models will descent from ActiveRecord::Base.
|
||||
|
||||
app/views
|
||||
Holds the template files for the view that should be named like
|
||||
weblog/index.rhtml for the WeblogController#index action. All views uses eRuby
|
||||
syntax. This directory can also be used to keep stylesheets, images, and so on
|
||||
that can be symlinked to public.
|
||||
|
||||
app/helpers
|
||||
Holds view helpers that should be named like weblog_helper.rb.
|
||||
|
||||
config
|
||||
Configuration files for the Rails environment, the routing map, the database, and other dependencies.
|
||||
|
||||
components
|
||||
Self-contained mini-applications that can bundle controllers, models, and views together.
|
||||
|
||||
lib
|
||||
Application specific libraries. Basically, any kind of custom code that doesn't
|
||||
belong controllers, models, or helpers. This directory is in the load path.
|
||||
|
||||
public
|
||||
The directory available for the web server. Contains sub-directories for images, stylesheets,
|
||||
and javascripts. Also contains the dispatchers and the default HTML files.
|
||||
|
||||
script
|
||||
Helper scripts for automation and generation.
|
||||
|
||||
test
|
||||
Unit and functional tests along with fixtures.
|
||||
|
||||
vendor
|
||||
External libraries that the application depend on. This directory is in the load path.
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
# Tracks: a GTD web application, built with Ruby on Rails
|
||||
|
||||
* Homepage: http://www.rousette.org.uk/projects/
|
||||
* Trac (for bug reports): http://dev.rousette.org.uk/report/6
|
||||
* Wiki (more info on installation): http://dev.rousette.org.uk/wiki
|
||||
* Author: bsag (http://www.rousette.org.uk/)
|
||||
* Contributors: Nicholas Lee, Lolindrath, Jim Ray, Arnaud Limbourg, Timothy Martens, Luke Melia, John Leonard (for great installation tutorials on Windows XP), Jim Strupp, Eric Lesh, Damien Cirotteau, Janet Riley
|
||||
* Version: 1.041
|
||||
* Copyright: (cc) 2004-2006 rousette.org.uk. Some portions (c) 2006 Coda Hale.
|
||||
* License: GNU GPL
|
||||
|
||||
While fully usable for everyday use, Tracks is still a work in progress. Make sure that you take sensible precautions and back up all your data frequently. Full changenotes can be found in `doc/CHANGENOTES.txt`. Full API documentation can be found at `doc/app/index.html`, once you have run `rake appdoc`
|
||||
|
||||
**IF THIS CRASHES YOUR MACHINE AND LOSES YOUR DATA, IT'S NOT MY FAULT!**
|
||||
|
||||
## Installation
|
||||
|
||||
Before you start, you need to make sure that you have Ruby 1.8.2 or 1.8.4 installed (1.8.3 is not supported, and 1.8.4 is recommended). Rails 1.1 and RedCloth are now included in the vendor directory of the distribution, so you don't need to install them yourself. You also need some kind of database. MySQL is probably the most popular, but it's also easy to use PostgreSQL or SQLite/SQLite3. Note that upgrading via the `rake db:migrate` command is quite a bit more tricky currently with SQLite and SQLite3. If you have Mac OS X Tiger, you already have Ruby 1.8.2 and SQLite3 installed, so all you need to do after installing Rails and Redcloth is to install the sqlite3-ruby gem (1.1.0). If you're using MySQL, you might want to install the native MySQL bindings to improve performance:
|
||||
|
||||
sudo gem install mysql
|
||||
|
||||
On Mac OS X, you need the following:
|
||||
|
||||
sudo gem install mysql -- --with-mysql-dir=/usr/local/mysql
|
||||
|
||||
See the [wiki](http://dev.rousette.org.uk/wiki/Tracks/Install) for more details on installing all the necessary components on all the supported platforms.
|
||||
|
||||
The full installation instructions are in the document installation.html at the root level of this Tracks directory, or here:
|
||||
<http://www.rousette.org.uk/projects/manual/comments/new-installations/>
|
||||
|
||||
|
||||
## Contacting me
|
||||
|
||||
I'd love any suggestions you have for improvements, bug-fixes etc. Email me at: butshesagirl@rousette.org.uk
|
||||
|
||||
You can also leave bug reports, feature requests, and comments at: http://dev.rousette.org.uk/report/6
|
||||
|
||||
Subscribe to the tracks-discuss mailing list [here](http://lists.rousette.org.uk/mailman/listinfo/tracks-discuss) or by sending an email to tracks-discuss-join@lists.rousette.org.uk.
|
||||
Loading…
Add table
Add a link
Reference in a new issue