regluit/README.md

regluit
=======

A 'monolithic' alternative to [unglu](http://github.com/gluejar/unglu) 
for the unglue.it website. regluit is essentially a Django project that 
contains three applications: `frontend`, `api` and `core` that can be deployed 
and configured on as many ec2 instances that are needed to support traffic. 
The key difference with [unglu](http://github.com/gluejar/unglu) is that the 
`frontend` app is able to access database models from `core` in the same 
way that the `api` is able to...which hopefully should simplify some things.

Develop
-------

Here are some instructions for setting up regluit for development on 
an Ubuntu system. If you are on OS X you will need to use 
[Homebrew](http://mxcl.github.com/homebrew/) or some other package manager
to install Python and python-setuptools in step 1:

1. `aptitude install python-setuptools`
1. `sudo easy_install virtualenv virtualenvwrapper`
1. `git clone git@github.com:Gluejar/regluit.git`
1. `cd regluit`
1. `mkvirtualenv --no-site-packages regluit`
1. `pip install -r requirements.pip`
1. `add2virtualenv ..`
1. `cp settings/dev.py settings/me.py`
1. edit `settings/me.py` and set `EMAIL_HOST_USER` and `EMAIL_HOST_PASSWORD`  to your gmail username and password, if you want to see that registration emails will work properly.
1. edit `settings/me.py` and look at the facebook, twitter and google auth settings to enable federated logins from those sites
1. `echo 'export DJANGO_SETTINGS_MODULE=regluit.settings.me' >> ~/.virtualenvs/regluit/bin/postactivate`
1. `deactivate ; workon regluit`
1. `django-admin.py syncdb --migrate`
1. `django-admin.py testserver --addrport 0.0.0.0:8000` (you can change the port number from the default value of 8000)
1. point your browser at http://localhost:8000/
initial commit 2011-08-31 01:05:23 +00:00			`regluit`
setup api, core and frontend apps, also added initial homepage template from stefan 2011-08-31 03:46:55 +00:00			`=======`

			`A 'monolithic' alternative to [unglu](http://github.com/gluejar/unglu)`
fixed typo 2011-09-06 04:09:18 +00:00			`for the unglue.it website. regluit is essentially a Django project that`
			contains three applications: `frontend`, `api` and `core` that can be deployed
			`and configured on as many ec2 instances that are needed to support traffic.`
another typo 2011-09-06 04:10:03 +00:00			`The key difference with [unglu](http://github.com/gluejar/unglu) is that the`
a bit more explanation 2011-08-31 03:53:02 +00:00			`frontend` app is able to access database models from `core` in the same
typo 2011-08-31 03:54:52 +00:00			way that the `api` is able to...which hopefully should simplify some things.
setup api, core and frontend apps, also added initial homepage template from stefan 2011-08-31 03:46:55 +00:00
			`Develop`
initial commit 2011-08-31 01:05:23 +00:00			`-------`
setup api, core and frontend apps, also added initial homepage template from stefan 2011-08-31 03:46:55 +00:00
			`Here are some instructions for setting up regluit for development on`
more notes about OS X 2011-09-10 11:46:53 +00:00			`an Ubuntu system. If you are on OS X you will need to use`
notes about OS X 2011-09-10 11:46:25 +00:00			`[Homebrew](http://mxcl.github.com/homebrew/) or some other package manager`
			`to install Python and python-setuptools in step 1:`
setup api, core and frontend apps, also added initial homepage template from stefan 2011-08-31 03:46:55 +00:00
			1. `aptitude install python-setuptools`
			1. `sudo easy_install virtualenv virtualenvwrapper`
			1. `git clone git@github.com:Gluejar/regluit.git`
fixed typo: reglueit->regluit; added instructions to change port number for running regluit 2011-09-07 11:49:37 +00:00			1. `cd regluit`
setup api, core and frontend apps, also added initial homepage template from stefan 2011-08-31 03:46:55 +00:00			1. `mkvirtualenv --no-site-packages regluit`
			1. `pip install -r requirements.pip`
			1. `add2virtualenv ..`
removed gmail credentials and modified the installation to give instructions for creating a settings.me settings module where you can put your gmail credentials, which will not be put in git 2011-09-04 05:04:04 +00:00			1. `cp settings/dev.py settings/me.py`
doc fix 2011-09-10 11:49:44 +00:00			1. edit `settings/me.py` and set `EMAIL_HOST_USER` and `EMAIL_HOST_PASSWORD` to your gmail username and password, if you want to see that registration emails will work properly.
added details about logins via twitter, facebook and google 2011-09-06 01:50:55 +00:00			1. edit `settings/me.py` and look at the facebook, twitter and google auth settings to enable federated logins from those sites
removed gmail credentials and modified the installation to give instructions for creating a settings.me settings module where you can put your gmail credentials, which will not be put in git 2011-09-04 05:04:04 +00:00			1. `echo 'export DJANGO_SETTINGS_MODULE=regluit.settings.me' >> ~/.virtualenvs/regluit/bin/postactivate`
setup api, core and frontend apps, also added initial homepage template from stefan 2011-08-31 03:46:55 +00:00			1. `deactivate ; workon regluit`
			1. `django-admin.py syncdb --migrate`
fixed typo: reglueit->regluit; added instructions to change port number for running regluit 2011-09-07 11:49:37 +00:00			1. `django-admin.py testserver --addrport 0.0.0.0:8000` (you can change the port number from the default value of 8000)
added point-your-browser-at comment 2011-08-31 03:48:17 +00:00			`1. point your browser at http://localhost:8000/`