Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 58 lines (41 sloc) 1.959 kb
696b976 Minor edits for readability.
troyt authored
1 # Pinax Social
c408080 @srid Import samples from internal git repo
srid authored
2
c4a53bb @srid Add app intro to python and node demos
srid authored
3 Pinax is an open-source platform built on the Django Web Framework. It
4 provides numerous reusable Django apps, starter projects and
5 infrastructure tools. pinax-social, a social networking site, is its
696b976 Minor edits for readability.
troyt authored
6 "kitchen sink" demo demonstrating many of Pinax's features.
c4a53bb @srid Add app intro to python and node demos
srid authored
7
c408080 @srid Import samples from internal git repo
srid authored
8 ## Local development
9
7e32748 @srid pinax-social: install mysql via pypm (faster)
srid authored
10 pypm install -r requirements.txt
11 pip install --user -r requirements.pip
c408080 @srid Import samples from internal git repo
srid authored
12 python manage.py syncdb
13 python manager.py runserver
14
15 ## Deploying to Stackato
16
a78cf22 @srid Document configuring email settings for the pinax-social demo
srid authored
17 Optionally, if you want the app to be able to send emails
18 successfully, specify the mail server settings in your Django
19 settings.py. If you have a SMTP backend, for instance, add the
20 following to settings.py:
21
22 EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
23 EMAIL_HOST = 'smtp.mycompany.com'
24 EMAIL_PORT = '25'
25 EMAIL_HOST_USER = 'smtpuser'
26 EMAIL_HOST_PASSWORD = 'pass'
27 EMAIL_USE_TLS = True
28
29 See the [Django
30 documentation](https://docs.djangoproject.com/en/dev/topics/email/#smtp-backend)
31 for further details. Then deploy your app,
32
cb2f754 @srid Make a few python sample apps use stackato.yml (even in README)
srid authored
33 stackato push -n
769d9db @srid Email notifications will only be sent on running manage.py commands.
srid authored
34
35 ### Setup cron job for sending emails
36
37 Run the following command as a cron job on your own server. You may
38 also run them manually.
39
40 stackato run pinax-social python manage.py send_mail
41 stackato run pinax-social python manage.py emit_notices
42
43 See the pinax documentation on [sending mail and
44 notices](http://pinaxproject.com/docs/dev/deployment/#sending-mail-and-notices).
45
8b2e89d @srid Forgot to commit left over changes for pinax README
srid authored
46 Email notifications will contain URLs with ``pinax-social.stackato.local`` as the
769d9db @srid Email notifications will only be sent on running manage.py commands.
srid authored
47 domain unless it is changed in fixtures/initial_data.json prior to
48 deployment or later in django admin.
c408080 @srid Import samples from internal git repo
srid authored
49
50 ### Limitations
51
8aff1d5 @srid update pinax-social limitations that are outdated
srid authored
52 * PyPM does not have certain packages (eg: PIL) or their older versions, so pip
53 is used (note: requirements.pip vs requirements.txt) to install most
54 packages.
c408080 @srid Import samples from internal git repo
srid authored
55
8aff1d5 @srid update pinax-social limitations that are outdated
srid authored
56 * Since it takes several minutes for pip to install all the dependencies,
57 `stackato push` (not `stackato update`) may take a few minutes to complete.
Something went wrong with that request. Please try again.