PluginCustomer

Version 5 (Stephen Herr, 2010-03-18 18:19)

1 1 Eric Davis
h1. Customer Plugin
2 1 Eric Davis
3 1 Eric Davis
This is a plugin for Redmine that can be used to track basic customer information for each project.  It was created so I could track which project belonged to which customer.
4 1 Eric Davis
5 1 Eric Davis
h2. Features
6 1 Eric Davis
7 1 Eric Davis
For this first release, I implemented the most basic features.
8 1 Eric Davis
9 1 Eric Davis
* Store Customer data
10 1 Eric Davis
* Associate a Customer for each project
11 1 Eric Davis
* Permissions to control user access to data
12 1 Eric Davis
13 2 Eric Davis
h2. Screenshot
14 2 Eric Davis
15 2 Eric Davis
!customer-screenshot_thumb.png!:/attachments/download/558
16 2 Eric Davis
17 3 Eric Davis
h2. Getting the plugin
18 3 Eric Davis
19 3 Eric Davis
A copy of the released version can be downloaded from "Little Stream Software":https://projects.littlestreamsoftware.com/projects/redmine-customers/files.  A development copy can be downloaded from "GitHub":http://github.com/edavis10/redmine-customer-plugin/tree/master
20 3 Eric Davis
21 1 Eric Davis
h2. Install
22 1 Eric Davis
23 3 Eric Davis
1. Follow the Redmine plugin installation steps at: [[Plugins]] Make sure the plugin is installed to @vendor/plugins/customer_plugin@
24 5 Stephen Herr
2. Setup the database using the migrations. @rake db:migrate_plugins@  or @rake db:migrate_plugins RAILS_ENV=production@ if you are still configuring and testing and have not set up the final environment.
25 3 Eric Davis
3. Login to your Redmine install as an Administrator
26 3 Eric Davis
4. Setup the permissions for your roles
27 3 Eric Davis
5. Add the "Customer module" to the enabled modules for your project
28 3 Eric Davis
6. The link to the plugin should appear on that project's navigation as Customer
29 1 Eric Davis
30 1 Eric Davis
h2. Usage
31 1 Eric Davis
32 1 Eric Davis
# Use the "New" link to create a Customer.
33 1 Eric Davis
# Once you have created a customer, use the "Assign" link to assign a customer to a Project.
34 1 Eric Davis
# Continue doing steps 1 and 2 until you have assigned customers to all your projects you need.
35 1 Eric Davis
36 1 Eric Davis
h2. Upgrade
37 1 Eric Davis
38 1 Eric Davis
h3. Zip file
39 1 Eric Davis
40 3 Eric Davis
# Download the latest zip file from https://projects.littlestreamsoftware.com/projects/redmine-customers/files
41 1 Eric Davis
# Unzip the file to your Redmine into vendor/plugins
42 1 Eric Davis
# Restart your Redmine
43 1 Eric Davis
44 1 Eric Davis
h3. Git
45 1 Eric Davis
46 1 Eric Davis
# Open a shell to your Redmine's vendor/plugins/customer_plugin folder
47 1 Eric Davis
# Update your git copy with `git pull`
48 1 Eric Davis
# Restart your Redmine
49 1 Eric Davis
50 1 Eric Davis
h2. License
51 1 Eric Davis
52 1 Eric Davis
This plugin is licensed under the GNU GPL v2.  See LICENSE.txt and GPL.txt for details.
53 1 Eric Davis
54 1 Eric Davis
If you would like to report a bug or request a new feature the bug tracker is located at  https://projects.littlestreamsoftware.com
55 1 Eric Davis
56 1 Eric Davis
h2. News
57 1 Eric Davis
58 1 Eric Davis
"0.1.0 Release announcement":http://theadmin.org/articles/2008/5/22/redmine-customer-plugin (2008-05-22)
59 3 Eric Davis
"0.2.0 Release announcement":http://theadmin.org/articles/2009/3/24/customer-plugin-v0-2-0-released (2009-03-24)