doc/README_FOR_APP

   1 Thanks for your interest in Boxroom.\r
   2 \r
   3 Boxroom is a web application for sharing and managing files online. The goal is to let a group of people share their files with each other. To make this possible the application lets users create folders and up/download files in a web browser. Furthermore for administrators it will be possible to create users, user groups and the CRU/D rights these groups will have on folders.\r
   4 \r
   5 Boxroom is developed using the Ruby on Rails web development framework.\r
   6 Check out http://www.rubyonrails.org for more info. As Ruby on Rails forces you to use the Model-View-Controller pattern, Boxroom consists of a number of Models, Views and Controllers. The Models, Controllers and the Helpers for the Views are listed below. They are intended to help you find your way around this Rails Application Documentation.\r
   7 \r
   8 Models:\r
   9     Clipboard\r
  10     Folder\r
  11     Group\r
  12     GroupPermission\r
  13     Myfile\r
  14     PasswordMailer\r
  15     Usage\r
  16     User\r
  17 \r
  18 Controllers:\r
  19     ApplicationController\r
  20     AuthenticationController\r
  21     ClipboardController\r
  22     FileController\r
  23     FolderController\r
  24     GroupController\r
  25     SearchController\r
  26     UserController\r
  27 \r
  28 Helpers:\r
  29     ApplicationHelper\r
  30     AuthenticationHelper\r
  31     ClipboardHelper\r
  32     FileHelper\r
  33     FolderHelper\r
  34     GroupHelper\r
  35     SearchHelper\r
  36     UserHelper\r
  37 \r
  38 \r
  39 I hope Boxroom will be useful for you.\r
  40 \r
  41 Mischa Berger <boxroomcomments at gmail dot com>