Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. It’s easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesHome
Welcome to the Fat Free CRM wiki!
Fat Free CRM is open source Ruby on Rails-based customer relationship management
(CRM) platform designed for small teams.
This wiki is used to generate the documentation at guides.fatfreecrm.com.
Please feel free to contribute!
Getting Started
-
Overview
- An introduction to Fat Free CRM
Installation
-
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
-
Upgrading Fat Free CRM
- Notes on the important changes between different version of Fat Free CRM
Configuration
-
Loading Demo Data
- Load sample data to test out Fat Free CRM
-
Site-wide Settings
- Configure your Fat Free CRM installation
Navigating the User Interface
Digging Deeper
-
Running as a Rails Engine
- Run Fat Free CRM within a separate Rails application
- Email Dropbox
- Rake Command Reference
- Available Plugins
- Creating Custom Field Plugins
- Providing Feedback
- Frequently Asked Questions
Developers
- Using Zeus to speed up development
- Running tests
- Creating a plugin
- Lazy Load Hooks
- Callback Hooks
- Localization Guidelines
- The Countries Problem and How to Fix It
- Translating Fat Free CRM
Community
- Security – responsible disclosure of security vulnerabilities
- Fat Free CRM Contributors
- Contributing to this guide