Project Name

TODO: component-referrals

Installation

TODO: Describe the installation process

1) npm install https://<LOGIN>:<PASSWORD>@bitbucket.org/sumraprague/component-referrals.git

Usage

2. import { Referrals } from 'component-referrals'

TODO: Write usage instructions

   	You should pass this configuration object to Referral component
   	const config = {
	routes: {
	    goToPionerMember
	},
	actions: {
	    actionFetchCodes,
	    actionDeleteCode,
	    actionGenerateCode,
	    actionPostCode,
	},
	data: {
	    referralCodes,
	    referralCode,
	    people,
	}
	}
	
	
	Your usage will be <Referrals config={config} />
	
	
	ROUTES - object of redirects for buttons and other
	
	examples:
	
		const goToPionerMember = () => history.push({
		pathname: '/address',
		state: {
		    prevPath: location.pathname,
		}
		});
		
	ACTIONS - actions for redux. You need to use is to interact with your app's storage. Data is passed to these methods so will get data in your Reducer and you can manage your store.
    
    actionFetchCodes - for passing all referral objects to add to store
    actionDeleteCode - for passing id of a deleted referral to delete from store
    actionGenerateCode - for passing a new generated referral object to add it to list of referrals in store
    actionPostCode - for passing a last generated code to add this object to store
    
   
recomended redux architecture
 	referralCodes: [] - for all referrals (actionFetchCodes, actionDeleteCode, actionGenerateCode - all this actions should interact with this property of STORE)
   	referralCode: {} - for a last generated referral (actionPostCode - should pass a referral object to this property of STORE)
    	

DATA
            referralCodes = list of referral objects
	    referralCode = a last generated referral object 
	    people - array of object