Project

General

Profile

PluginCustomer » History » Version 1

Eric Davis, 2008-05-23 00:46
Adding documentation for the Customer Plugin

1 1 Eric Davis
h1. Customer Plugin
2
3
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
5
h2. Features
6
7
For this first release, I implemented the most basic features.
8
9
* Store Customer data
10
* Associate a Customer for each project
11
* Permissions to control user access to data
12
13
h2. Install
14
15
# Download the "archive file":https://projects.littlestreamsoftware.com/projects/list_files/redmine-customers and extract it to your @vendor/plugins@ folder.  You can also download directly from "GitHub":http://github.com/edavis10/redmine-customer-plugin/tree/master using git:
16
         <pre>git clone git://github.com/edavis10/redmine-customer-plugin.git vendor/plugins/customer_plugin</pre>
17
# Follow the Redmine [plugin installation][4] steps.  Make sure to install Engines 2 if you use Rails 2.0.
18
# Setup the database using the migrations.
19
         <pre>rake db:migrate_plugins</pre>
20
# Login to your Redmine install as an Administrator
21
# Setup the permissions for your roles
22
# Add the "Customer module" to the enabled modules for your project
23
# The link to the plugin should appear on that project's navigation as Customer
24
25
h2. Usage
26
27
# Use the "New" link to create a Customer.
28
# Once you have created a customer, use the "Assign" link to assign a customer to a Project.
29
# Continue doing steps 1 and 2 until you have assigned customers to all your projects you need.
30
31
h2. Upgrade
32
33
h3. Zip file
34
35
# Download the latest zip file from https://projects.littlestreamsoftware.com/projects/list_files/redmine-customers
36
# Unzip the file to your Redmine into vendor/plugins
37
# Restart your Redmine
38
39
h3. Git
40
41
# Open a shell to your Redmine's vendor/plugins/customer_plugin folder
42
# Update your git copy with `git pull`
43
# Restart your Redmine
44
45
h2. License
46
47
This plugin is licensed under the GNU GPL v2.  See LICENSE.txt and GPL.txt for details.
48
49
If you would like to report a bug or request a new feature the bug tracker is located at  https://projects.littlestreamsoftware.com
50
51
h2. News
52
53
"0.1.0 Release announcement":http://theadmin.org/articles/2008/5/22/redmine-customer-plugin (2008-05-22)