modules/market/INSTALL.txt



Many of these piecese are manual.  That's a bummer.  I'd like to make them happen automatically on install.  Help with that is greatly appreciated ;)

Note: This module should only be installed on a brand new site.  It assumes that almost no configuration has been performed on the site prior to the installation of the module.


+++ Installation Steps:

1. Install the Market module.  Unzip the tar.gz file and place it into your modules directory.  You will also need several other modules.  The exact list is available in the market.info file but currently is 

   cck including: content number nodereference text optionwidgets content_copy
   userpoints 5.x-3 and userpoints_contrib: userpoints userpoints_no_negative 
   pressflow_transaction workflow views auto_nodetitles token

2. The installer will automatically create the cck content types.

3. Workflows for your trades, items, and portfolios should be created automatically.  For testing purposes you may want to allow your admin to make state transitions like from "canceled to open" which are not recommended in general.

By default the workflows let the authors of trades, items, and portfolios move them into the open state.  For trades they can also cancel the trade.  You may also want to let them move items from open to "Pending Decision" or all the way to "Closed Success" and "Closed Failure".  The exact states changes that the author can perform will depend on whether the authors are casual users or if they are involved in running and deciding the markets.

4. Create a "market_robot" user who is given the role of "market admin"  That role was created during install.  Feel free to rename it.

5. Admin > Settings > Userpoints.  Set moderation to "Approved" and basically leave everything else alone (aside from messages - hide those if you want).

6. Admin > User > Userpoints.  Give some people some points (especially for testing).


+++ Important Configuration Reminders
1. Be sure that regular users cannot edit trades.  Maybe don't even let admins edit trades.

2. You should probably enable revisions by default on every content type.  Trades and points are like money.  Transactions involving money deserve a good audit trail even if it comes at the cost of a slight performance overhead.

3. You should probably enable menu items to point to "/item_count" and "/trades" which are the default views.  

4. You may want to configure the automatic node titles which are generated for each content type.
1
2
3	Many of these piecese are manual. That's a bummer. I'd like to make them happen automatically on install. Help with that is greatly appreciated ;)
4
5	Note: This module should only be installed on a brand new site. It assumes that almost no configuration has been performed on the site prior to the installation of the module.
6
7
8	+++ Installation Steps:
9
10	1. Install the Market module. Unzip the tar.gz file and place it into your modules directory. You will also need several other modules. The exact list is available in the market.info file but currently is
11
12	cck including: content number nodereference text optionwidgets content_copy
13	userpoints 5.x-3 and userpoints_contrib: userpoints userpoints_no_negative
14	pressflow_transaction workflow views auto_nodetitles token
15
16	2. The installer will automatically create the cck content types.
17
18	3. Workflows for your trades, items, and portfolios should be created automatically. For testing purposes you may want to allow your admin to make state transitions like from "canceled to open" which are not recommended in general.
19
20	By default the workflows let the authors of trades, items, and portfolios move them into the open state. For trades they can also cancel the trade. You may also want to let them move items from open to "Pending Decision" or all the way to "Closed Success" and "Closed Failure". The exact states changes that the author can perform will depend on whether the authors are casual users or if they are involved in running and deciding the markets.
21
22	4. Create a "market_robot" user who is given the role of "market admin" That role was created during install. Feel free to rename it.
23
24	5. Admin > Settings > Userpoints. Set moderation to "Approved" and basically leave everything else alone (aside from messages - hide those if you want).
25
26	6. Admin > User > Userpoints. Give some people some points (especially for testing).
27
28
29	+++ Important Configuration Reminders
30	1. Be sure that regular users cannot edit trades. Maybe don't even let admins edit trades.
31
32	2. You should probably enable revisions by default on every content type. Trades and points are like money. Transactions involving money deserve a good audit trail even if it comes at the cost of a slight performance overhead.
33
34	3. You should probably enable menu items to point to "/item_count" and "/trades" which are the default views.
35
36	4. You may want to configure the automatic node titles which are generated for each content type.