mailr/README.markdown

Introduction

Mailr is a IMAP mail client based on Ruby on Rails platform.

NOTE All path and filenames are based on Rails.root directory.

Requirements

In Rails 3 all dependencies should be defined in file Gemfile. All needed gems can be installed using bundler.

Installation procedure

• Checkout the source code.

• Install all dependiences. Use bundler for that.

• Prepare config/database.yml file (see config/database.yml.example). Check if proper gems (sqlite3/mysql/postgresql) are defined in Gemfile and installed.

• Migrate database (rake db:migrate)

• Start rails server if applicable

• Point Your browser to application URL: For local access: http://localhost:3000 For remote access: http://some_url/mailr

• Use it.