yarka / fat_free_crm

Ruby on Rails CRM platform for Web 2.0 and beyond

Fat Free CRM

An open source, Ruby on Rails customer relationship management platform (CRM).

Out of the box it features group collaboration, campaign and lead management, contact lists, and opportunity tracking.

Contacts

Opportunities

Accounts

Tasks

Active development started in November 2008. New features, enhancements, and updates appear on regular basis.

Pull requests and bug reports are always welcome!

System Requirements

• Ruby v1.8.7 or v1.9.2
• MySQL v4.1.1 or later (v5+ is recommended), SQLite v3.4 or later, or Postgres 8.4.8 or later.
• ImageMagick (optional, only needed if you would like to use avatars)

(Ruby on Rails and other gem dependencies will be installed automatically by Bundler.)

Downloads

• Git source code repository: git clone git://github.com/fatfreecrm/fat_free_crm.git
• .zip or .tgz archives: http://github.com/fatfreecrm/fat_free_crm/downloads

Installation

Please view one of the following installation guides:

Setup Linux or Mac OS

Installing Fat Free CRM on Linux or Mac OS X

Setup Heroku

Setting up a Heroku instance for Fat Free CRM

Setup Microsoft Windows

Installing Fat Free CRM on Microsoft Windows

Ubuntu Server Setup Script

Run this bash script to quickly setup a Ubuntu server

Running Fat Free CRM as a Rails Engine

Run the Fat Free CRM gem within a separate Rails application. This is the best way to deploy Fat Free CRM if you need to add plugins or make any customizations.

Upgrading from previous versions of Fat Free CRM

If you are upgrading from version 0.10.1 or below to the latest Rails 3.x version, your database schema needs to be updated.

Please run the following commands in this order:

bundle install --without heroku   # Installs gem dependencies
rake ffcrm:upgrade:schema         # Updates your schema to use the new timestamped migrations
rake db:migrate                   # Runs any new database migrations.

Resources

Home Page:	http://www.fatfreecrm.com
Guides:	http://guides.fatfreecrm.com
Online Demo:	http://demo.fatfreecrm.com
Github Project Page:	http://github.com/fatfreecrm/fat_free_crm
Feature Requests and Bugs:	http://support.fatfreecrm.com/
RDoc API:	http://api.fatfreecrm.com
Twitter Commit Updates:	http://twitter.com/fatfreecrm
User's Google Group:	http://groups.google.com/group/fat-free-crm-users
Developer's Google Group:	http://groups.google.com/group/fat-free-crm-dev
IRC Channel:	#fatfreecrm on irc.freenode.net

For Developers

Fat Free CRM can be customized by implementing callback hooks and extended by creating Rails Engines plugins. Check out these sample repositories demonstrating the concepts:

• http://github.com/michaeldv/crm_sample_plugin/tree/master
• http://github.com/michaeldv/crm_sample_tabs/tree/master
• http://github.com/michaeldv/crm_web_to_lead/tree/master
• http://github.com/michaeldv/crm_tags/tree/master

License

Copyright (c) 2008-2011 by Michael Dvorkin. All rights reserved.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See LICENSE file for more details.