Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 142 lines (85 sloc) 4.67 kb
959c734 @ndbroadbent Updated README file.
ndbroadbent authored
1 === Welcome to Fat Free CRM!
2
3 Fat Free CRM is next generation open source CRM platform. Active development
4 has started in November 2008; new features, enhancements, and updates appear
5 on daily basis.
6
7 Here are the steps to get Fat Free CRM up and running on your system.
8
9
10 === System Requirements
11
12 * Ruby v1.8.7 or v1.9.2
13 * MySQL v4.1.1 or later (v5+ is recommended), SQLite v3.4 or later, or Postgres 8.4.8 or later.
14 * ImageMagick (optional, only if you would like to use avatars)
15
16 (Ruby on Rails v3 and other gem dependencies will be installed automatically by Bundler.)
17
18 === Downloads
19
20 * Git source code repository: git://github.com/michaeldv/fat_free_crm.git
21 * .zip or .tgz archives: http://github.com/michaeldv/fat_free_crm/downloads
22
23
d164d42 @ndbroadbent Added instructions for updating from an older version of FFCRM
ndbroadbent authored
24 === Upgrading from a previous version of Fat Free CRM
25
26 If you are upgrading from version 0.10.1 or below, your database schema
27 needs to be updated. After you have installed the latest Rails 3 version,
28 please run the following commands in this order:
29
30 $ bundle install # Installs gem dependencies
31 $ rake crm:upgrade:schema # Updates your old schema to use the new timestamped migrations
32 $ rake db:migrate # Runs the new database migrations.
33
959c734 @ndbroadbent Updated README file.
ndbroadbent authored
34
ce7c43b @ndbroadbent Added more database notes to README
ndbroadbent authored
35 === Setting Up The Database Configuration
959c734 @ndbroadbent Updated README file.
ndbroadbent authored
36
37 Fat Free CRM supports MySQL and SQLite databases. The source code comes with
38 two sample database configuration files: +config+/+database+.+mysql+.+yml+
39 for MySQL and +config+/+database+.+sqlite+.+yml+ for SQLite. Based on your choice
40 of the database create the actual database configuration file, for example:
41
42 $ cp config/database.mysql.yml config/database.yml
43
44 Edit config/database.yml and specify database names and authentication
ce7c43b @ndbroadbent Added more database notes to README
ndbroadbent authored
45 details.
46
47
48 === Installing Gem Dependencies
49
50 Fat Free CRM includes a 'smart' Gemfile that detects your chosen database,
51 and installs the required gems. After you have configured your database.yml file,
52 run the following command from the applications root directory:
53
54 $ bundle install
55
56
57 === Create The Database
58
59 Now you are ready to create the database:
959c734 @ndbroadbent Updated README file.
ndbroadbent authored
60
61 $ rake db:create
62
63
64 === Setting Up The Application
65
66 The next step is to load default Fat Free CRM settings, such as menu structures,
67 default colors, etc. and create the Admin user. This is done by running the
68 following rake task:
69
70 $ rake crm:setup
71
72
73 === Loading Demo Data
74
75 You can test drive Fat Free CRM by loading sample records that are generated
76 on the fly mimic the actual use. IMPORTANT: loading demo will delete all the
77 existing data.
78
79 $ rake crm:demo:load
80
81 Among other things the demo generator creates 8 sample user records with the
82 following usernames: +aaron+, +ben+, +cindy+, +dan+, +elizabeth+, +frank+, +george+,
83 and +heather+. You can log in with any of these names using the name as password.
84 The demo site at http://demo.fatfreecrm.com provides access as a sample user as well.
85
86 You can reset the database and reload demo data at any time by using:
87
88 $ rake crm:demo:reload
89
90
91 === Running The App
92
93 Now you should be able to launch the Rails server and point your web browser
94 to http://localhost:3000
95
96 $ ruby script/server
97
98 When deploying with Phusion Passenger, also install Rack 1.0.1:
99
100 $ gem install rack -v 1.0.1
101
102
d164d42 @ndbroadbent Added instructions for updating from an older version of FFCRM
ndbroadbent authored
103 === Resources
104
105 * Home page: http://www.fatfreecrm.com
106 * Online demo: http://demo.fatfreecrm.com
107 * Project page: http://github.com/michaeldv/fat_free_crm/tree/master
108 * Features and bugs: http://fatfreecrm.lighthouseapp.com
109 * Twitter commit updates: http://twitter.com/fatfreecrm
110 * Discussion group for users: http://groups.google.com/group/fat-free-crm-users
111 * Discussion group for developers: http://groups.google.com/group/fat-free-crm-dev
112 * IRC channel: #fatfreecrm on irc.freenode.net
113
114
959c734 @ndbroadbent Updated README file.
ndbroadbent authored
115 === For Developers
116
117 Fat Free CRM can be customized by implementing callback hooks and extended by
118 creating Rails Engines plugins. Check out these sample repositories demonstrating
119 the concepts:
120
121 http://github.com/michaeldv/crm_sample_plugin/tree/master
122 http://github.com/michaeldv/crm_sample_tabs/tree/master
123 http://github.com/michaeldv/crm_web_to_lead/tree/master
124 http://github.com/michaeldv/crm_tags/tree/master
125
126
127 === License
128
129 Copyright (c) 2008-2011 by Michael Dvorkin. All rights reserved.
130
131 This program is free software: you can redistribute it and/or modify it
132 under the terms of the GNU Affero General Public License as published by
133 the Free Software Foundation, either version 3 of the License, or (at your
134 option) any later version.
135
136 This program is distributed in the hope that it will be useful, but WITHOUT
137 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
138 FOR A PARTICULAR PURPOSE.
139
140 See LICENSE file for more details.
141
Something went wrong with that request. Please try again.