Skip to content
This repository
Newer
Older
100644 234 lines (163 sloc) 7.639 kb
eb2941fd »
2011-10-10 Made travis image use https to avoid caching [ci skip]
1 # Fat Free CRM [![TravisCI](https://travis-ci.org/fatfreecrm/fat_free_crm.png?branch=master)](http://travis-ci.org/fatfreecrm/fat_free_crm)
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
2
da9ba081 »
2011-09-27 Updated README to match content found on fatfreecrm.com [ci skip]
3 **An open source, Ruby on Rails
4 [customer relationship management (CRM)](http://en.wikipedia.org/wiki/Customer_relationship_management)
5 platform.**
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
6
da9ba081 »
2011-09-27 Updated README to match content found on fatfreecrm.com [ci skip]
7 Out of the box it features group collaboration, campaign and lead management, contact lists, and opportunity tracking.
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
8
0ebf887a »
2011-09-27 Added screenshots to README (from fatfreecrm.com) [ci skip]
9 <table>
10 <tr>
11 <td align="center">
12 <a href="http://fatfreecrm.com/images/contact_create.png" target="_blank" title="Create Contacts">
13 <img src="http://fatfreecrm.com/images/contact_create_t.png" alt="Create Contacts">
14 </a>
15 <br />
16 <em>Contacts</em>
17 </td>
18 <td align="center">
19 <a href="http://fatfreecrm.com/images/contact_opportunity.png" target="_blank" title="Manage Opportunities">
20 <img src="http://fatfreecrm.com/images/contact_opportunity_t.png" alt="Manage Opportunities">
21 </a>
22 <br />
23 <em>Opportunities</em>
24 </td>
25 <td align="center">
26 <a href="http://fatfreecrm.com/images/account_edit.png" target="_blank" title="Edit Accounts">
27 <img src="http://fatfreecrm.com/images/account_edit_t.png" alt="Edit Accounts">
28 </a>
29 <br />
30 <em>Accounts</em>
31 </td>
32 <td align="center">
33 <a href="http://fatfreecrm.com/images/task_create.png" target="_blank" title="Create Tasks">
34 <img src="http://fatfreecrm.com/images/task_create_t.png" alt="Create Tasks">
35 </a>
36 <br />
37 <em>Tasks</em>
38 </td>
39 </tr>
40 </table>
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
41
da9ba081 »
2011-09-27 Updated README to match content found on fatfreecrm.com [ci skip]
42 Active development started in November 2008.
43 New features, enhancements, and updates appear on regular basis.
44
45 Pull requests and bug reports are always welcome!
46
6f606fb0 »
2011-10-26 Changed user survey link to 'vote for new name' survey [ci skip]
47 ## Help us find a new name!
acc91f71 »
2011-10-06 Added survey link to README
48
6f606fb0 »
2011-10-26 Changed user survey link to 'vote for new name' survey [ci skip]
49 The results of our previous survey are in, and we have decided to give this application a new name.
50 [Please click here to vote on your favorite names.](https://docs.google.com/spreadsheet/viewform?formkey=dG05QlBqbHFVMmFIdHNVT0ZtYWVzQ2c6MQ&theme=0AX42CRMsmRFbUy04ZWQwMDYwMS02YjZhLTQ2ZjMtYjcyNy0zYWNlMzlmYTAxNmY&ifq)
acc91f71 »
2011-10-06 Added survey link to README
51
0ebf887a »
2011-09-27 Added screenshots to README (from fatfreecrm.com) [ci skip]
52 ## System Requirements
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
53
54 * Ruby v1.8.7 or v1.9.2
55 * MySQL v4.1.1 or later (v5+ is recommended), SQLite v3.4 or later, or Postgres 8.4.8 or later.
3158130d »
2011-09-27 Added Travis CI build status image [ci skip]
56 * ImageMagick (optional, only needed if you would like to use avatars)
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
57
58 (Ruby on Rails v3 and other gem dependencies will be installed automatically by Bundler.)
59
60
61 ### Downloads
62
8c8b2945 »
2011-10-09 Fixed git and archive download links so they point to github.com/fatf…
63 * Git source code repository: git://github.com/fatfreecrm/fat_free_crm.git
64 * .zip or .tgz archives: http://github.com/fatfreecrm/fat_free_crm/downloads
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
65
66
67 ### Upgrading from previous versions of Fat Free CRM
68
69 If you are upgrading from version 0.10.1 or below to the latest Rails 3.x version, your database schema
70 needs to be updated.
71
72 Please run the following commands in this order:
73
74 ```bash
75 bundle install # Installs gem dependencies
3158130d »
2011-09-27 Added Travis CI build status image [ci skip]
76 rake crm:upgrade:schema # Updates your schema to use the new timestamped migrations
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
77 rake db:migrate # Runs any new database migrations.
78 ```
79
80 ## Install on Heroku
81
82 You will need the heroku gem on your system.
83
84 ```bash
85 gem install heroku
86 ```
87
88 To set up Fat Free CRM on Heroku, run the following commands:
89
90 ```bash
09a036b8 »
2011-12-08 Added more config/settings.yml.example info to README [ci skip]
91 cp config/settings.yml.example config/settings.yml
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
92 heroku create {organization-crm} --stack bamboo-mri-1.9.2
93 git push heroku master
94 heroku rake crm:setup USERNAME=admin PASSWORD=admin EMAIL=admin@example.com
5389fb1c »
2011-09-21 If we set the heroku config on the last step, it automatically restar…
95 heroku config:add HEROKU=true
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
96 ```
97
98 ## Install locally, or on a server
99
09a036b8 »
2011-12-08 Added more config/settings.yml.example info to README [ci skip]
100 #### Set Up Configuration (Database & Settings)
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
101
102 Fat Free CRM supports PostGreSQL, MySQL and SQLite databases. The source code comes with
103 sample database configuration files, such as: <tt>config/database.mysql.yml</tt>
104 for MySQL and <tt>config/database.sqlite.yml</tt> for SQLite.
105
106 Based on your choice of database, create <tt>config/database.yml</tt>:
107
108 ```bash
109 cp config/database.mysql.yml config/database.yml
110 ```
111
112 * Edit <tt>config/database.yml</tt> and specify database names and authentication details.
113
114 * Then, edit your <tt>Gemfile</tt> and uncomment only your chosen database.
115
09a036b8 »
2011-12-08 Added more config/settings.yml.example info to README [ci skip]
116
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
117 #### Install Gem Dependencies
118
119 After you have uncommented the right database adapter in your <tt>Gemfile</tt>,
120 run the following command from the application's root directory:
121
122 ```bash
123 bundle install
124 ```
125
126 #### Create Database
127
128 Now you are ready to create the database:
129
130 ```bash
131 rake db:create
132 ```
133
134 #### Set Up Application
135
136 The next step is to load default Fat Free CRM settings, such as menu structures,
4a07ca63 »
2011-11-26 Included section in README about copying settings.sample.yml to setti…
137 default colors, etc. and create the Admin user.
138
139 Using the provided sample, create your <tt>config/settings.yml</tt>:
140
141 ```bash
142 cp config/settings.yml.example config/settings.yml
143 ```
144
09a036b8 »
2011-12-08 Added more config/settings.yml.example info to README [ci skip]
145 * Edit <tt>config/settings.yml</tt> and configure any required settings, such as your host, base URL and language (locale).
146
4a07ca63 »
2011-11-26 Included section in README about copying settings.sample.yml to setti…
147
148 Next, run the following rake task:
37e1f9a8 »
2011-09-10 Converted README to markdown format (nicer tables and code highlighting)
149
150 ```bash
151 rake crm:setup
152 ```
153
154 The previous command will prompt you for an admin user, password and email.
155 If you want to run this task without any user input, you can set the following variables:
156
157 ```bash
158 rake crm:setup USERNAME=admin PASSWORD=password EMAIL=admin@example.com
159 ```
160
161 #### Load Demo Data (Optional)
162
163 You can test drive Fat Free CRM by loading sample records that are generated
164 on the fly mimic the actual use.
165
166 **IMPORTANT**: Loading demo will delete all existing data from your database.
167
168 ```bash
169 rake crm:demo:load
170 ```
171
172 Among other things the demo generator creates 8 sample user records with the
173 following usernames: <tt>aaron</tt>, <tt>ben</tt>, <tt>cindy</tt>, <tt>dan</tt>,
174 <tt>elizabeth</tt>, <tt>frank</tt>, <tt>george</tt>, and <tt>heather</tt>.
175 You can log in with any of these names using the name as password.
176 The demo site at http://demo.fatfreecrm.com provides access as a sample user as well.
177
178 You can reset the database and reload demo data at any time by using:
179
180 ```bash
181 rake crm:demo:reload
182 ```
183
184 #### Run the App
185
186 Now you should be able to launch the Rails server and point your web browser
187 to http://localhost:3000
188
189 ```bash
190 rails server
191 ```
192
193 # Resources
194
195 |||
196 |-----------------------------------:|:--------------------------|
197 | **Home page**: | http://www.fatfreecrm.com |
198 | **Online demo**: | http://demo.fatfreecrm.com |
199 | **Project page**: | http://github.com/michaeldv/fat_free_crm/tree/master |
200 | **Features and bugs**: | http://fatfreecrm.lighthouseapp.com |
201 | **Twitter commit updates**: | http://twitter.com/fatfreecrm |
202 | **User's Google group**: | http://groups.google.com/group/fat-free-crm-users |
203 | **Developer's Google group**: | http://groups.google.com/group/fat-free-crm-dev |
204 | **IRC channel**: | [#fatfreecrm](http://webchat.freenode.net/) on irc.freenode.net |
205
206
207 # For Developers
208
209 Fat Free CRM can be customized by implementing callback hooks and extended by
210 creating Rails Engines plugins. Check out these sample repositories demonstrating
211 the concepts:
212
213 * http://github.com/michaeldv/crm_sample_plugin/tree/master
214 * http://github.com/michaeldv/crm_sample_tabs/tree/master
215 * http://github.com/michaeldv/crm_web_to_lead/tree/master
216 * http://github.com/michaeldv/crm_tags/tree/master
217
218
219 ## License
220
221 Copyright (c) 2008-2011 by Michael Dvorkin. All rights reserved.
222
223 This program is free software: you can redistribute it and/or modify it
224 under the terms of the GNU Affero General Public License as published by
225 the Free Software Foundation, either version 3 of the License, or (at your
226 option) any later version.
227
228 This program is distributed in the hope that it will be useful, but WITHOUT
229 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
230 FOR A PARTICULAR PURPOSE.
231
232 See LICENSE file for more details.
233
Something went wrong with that request. Please try again.