2011-06-24 23:48:08 +02:00
|
|
|
## 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
|
2011-06-25 00:12:21 +02:00
|
|
|
|
2011-06-25 00:15:19 +02:00
|
|
|
In _Rails 3_ all dependencies should be defined in file _Gemfile_. All needed gems can be installed using bundler.
|
2011-06-24 23:48:08 +02:00
|
|
|
|
|
|
|
|
### Installation procedure
|
|
|
|
|
|
2011-06-25 00:12:21 +02:00
|
|
|
* Checkout the source code.
|
|
|
|
|
|
2011-07-21 20:20:15 +02:00
|
|
|
* Install all dependiences. Use _bundler_ for that.
|
2011-06-24 23:48:08 +02:00
|
|
|
|
2011-06-25 00:15:19 +02:00
|
|
|
* Prepare config/database.yml file (see _config/database.yml.example_).
|
2011-07-21 20:20:15 +02:00
|
|
|
Check if proper gems (sqlite3/mysql/postgresql) are defined in _Gemfile_ and installed.
|
2011-06-24 23:48:08 +02:00
|
|
|
|
2011-06-25 00:12:21 +02:00
|
|
|
* Migrate database (rake db:migrate)
|
2011-06-24 23:48:08 +02:00
|
|
|
|
2011-07-21 20:20:15 +02:00
|
|
|
* Start rails server if applicable
|
2011-06-24 23:48:08 +02:00
|
|
|
|
2011-07-21 20:20:15 +02:00
|
|
|
* Point Your browser to application URL:
|
|
|
|
|
For local access: http://localhost:3000
|
|
|
|
|
For remote access: http://some_url/mailr
|
|
|
|
|
|
|
|
|
|
* Use it.
|
