zhaque / yotweets.com Goto Github PK

Table of Contents
=================
1 Getting started
    1.1 Dependencies
    1.2 Starting the Project
    1.3 Configuration
    1.4 Deployment

1 Getting started
~~~~~~~~~~~~~~~~~

1.1 Dependencies
~~~~~~~~~~~~~~~~~
   Download all dependencies before proceeding to step 1, 
   You will need the following programs:
    - Python (2.5 or higher, 
    but may work on earlier versions of Python)
  - git,
  - tar accepting "-j" option (any recent GNU tar),
 
1.2 Starting the Project
~~~~~~~~~~~~~~~~~
  1. Create local_setting. Currently there is aleady a local_settings for sqlite in the repo. For example:
echo "
DATABASE_ENGINE = 'sqlite3'
DATABASE_NAME = 'yotweets.db'
DATABASE_USER = ''
DATABASE_PASSWORD = ''
DATABASE_HOST = ''
DATABASE_PORT = ''

CACHE_BACKEND = 'dummy:///'
" > ./src/yotweets/local_settings.py

  2. python ./bootstrap.py -c ./buildout.cfg # or production.cfg
  3. ./bin/buildout -c ./buildout.cfg #or production.cfg
  4. ./bin/site runserver
  
  5. Create a new group 'Editors' for templates admin (http://example.com/admin/templates) and assign 'admin' user to the 'Editors' group.

1.3 Configuration
~~~~~~~~~~~~~~~~~
  
	Required
		- ROOT_URL (ex. http://www.mywebsite.com)
			- External URL to access the site
			
		- CONSUMER_KEY and CONSUMER_SECRET
			- Must be values provided by twitter app registration
			- http://twitter.com/oauth_clients
			
		- TWITTER_USERNAME and TWITTER_PASSWORD
			- Username and password for global twitter account that users can post to

	Optional
		- SITE_TWEET_COST_FIXED and SITE_TWEET_COST_VARIABLE
			- Fixed and variable (per follower) point cost for posting to site's twitter
			
		- SHORT_BASE_URL (ex. http://mysite.com/)
			- External (short) URL to be prepended to shortened URL codes
			
		- PREPAID_UNIT_COST (defaults to 0.10)
			- Dollar value of each point, used to determine withdrawal value
			
		- PREPAID_MIN_WITHDRAWAL (defaults to 10)
			- Minimum points needed to perform a withdrawal
			
		- PREPAID_AUTO_APPROVE (defaults to True)
			- Automatically approve and fund withdrawals
			- If False, you must approve withdrawals manually using admin

		- PREPAID_UNIT_PACKS
			- A list of available unit pack sizes and their respective cost
			- Default: (
				(10, '1.29'),
				(100, '12.49'),
				(250, '29.99'),
				(500, '57.99'),
				(1000, '109.99'),
			)

			

1.4 Deployment
~~~~~~~~~~~~~~~~~
  1. It should be working copy, i.e. buildout have done.
  2. export DJANGO_SETTINGS_MODULE=yotweets.settings # replace saaskit by your project name
  3. ./bin/fab install_packages install_mail_transfer_agent log_setup github_config postgresql_setup webapp_setup install_project nginx_config apache2_config --fabfile=./src/saaskit/fabfile.py --user=root
  4. After that you may exec any of this steps. But some of them have no reason, i.e. user setup.