README

   1 == Documentation
   2
   3 Please visit our wiki at: http://wiki.mwamko.org
   4
   5
   6 == Launching
   7
   8 Run: ./script/mwamko start
   9
  10
  11 == Console
  12
  13 You can interact with the domain model by starting the console through
  14 script/console. Here you'll have all parts of the application configured,
  15 just like it is when the application is running. You can inspect domain
  16 models, change values, and save to the database. Starting the script without
  17 arguments will launch it in the development environment.
  18
  19 Passing an argument will specify a different environment,
  20 like: script/console production
  21
  22 To reload your controllers and models after launching the console
  23 run: reload!
  24
  25
  26 == Description of contents
  27
  28 app
  29   Holds all the code that's specific to this particular application.
  30
  31 app/controllers
  32   Holds controllers that should be named like weblog_controller.rb for
  33   automated URL mapping. All controllers should descend from
  34   ActionController::Base.
  35
  36 app/models
  37   Holds models that should be named like post.rb.
  38   Most models will descend from ActiveRecord::Base.
  39
  40 app/views
  41   Holds the template files for the view that should be named like
  42   weblog/index.rhtml for the WeblogController#index action. All views use eRuby
  43   syntax. This directory can also be used to keep stylesheets, images,
  44   and so on that can be symlinked to public.
  45
  46 app/helpers
  47   Holds view helpers that should be named like weblog_helper.rb.
  48
  49 config
  50   Configuration files for the Rails environment, the routing map,
  51   the database, and other dependencies.
  52
  53 db
  54   Contains the database schema in schema.rb.  db/migrate contains all
  55   the sequence of Migrations for your schema.
  56
  57 lib
  58   Application specific libraries. Basically, any kind of custom code
  59   that doesn't belong under controllers, models, or helpers. This
  60   directory is in the load path.
  61
  62 public
  63   The directory available for the web server. Contains subdirectories
  64   for images, stylesheets, and javascripts. Also contains the dispatchers
  65   and the default HTML files.
  66
  67 script
  68   Helper scripts for automation and generation.
  69
  70 test
  71   Unit and functional tests along with fixtures.
  72
  73 vendor
  74   External libraries that the application depends on. Also includes the
  75   plugins subdirectory. This directory is in the load path.