Skip to content

Latest commit

 

History

History
148 lines (105 loc) · 6.43 KB

README.md

File metadata and controls

148 lines (105 loc) · 6.43 KB
Raw

Fat Free CRM Code Climate Discord

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.

Create Contacts
Contacts 		Manage Opportunities
Opportunities 		Edit Accounts
Accounts 		Create Tasks
Tasks

Pull requests and bug reports are always welcome!

Visit our website at http://www.fatfreecrm.com/

System Requirements

  • Ruby 2.6+ recommended
  • 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.)

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

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. Note that it is not yet simple to 'bolt' Fat Free CRM into your existing rails project, but we're heading in that direction.

Upgrading from previous versions of Fat Free CRM

Please read the Changelog document for more detailed information on upgrading from previous versions.

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
Ruby gem: https://rubygems.org/gems/fat_free_crm
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 is released under the MIT license and is freely available for you to use for your own purposes. We do encourage contributions to make Fat Free CRM even better. Send us a pull-request and we'll do our best to accommodate your needs.

Specific features that are not 'Fat Free' in nature, can be added by creating Rails Engines. See the wiki for information on how to do this.

Tests can easily be run by typing 'rake' but please note that they do take a while to run!

Main contributors

See the contributors graph and the contributors file for further details.

License

Fat Free CRM Copyright (c) 2008-2018 Michael Dvorkin and contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.