first commit

Author: bigmassa

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.idea
+.postgres
+**__pycache__**
+*.pyc

Dockerfile

@@ -0,0 +1,30 @@
+FROM python:3.6-slim
+
+# Copy the application code to the container:
+RUN mkdir /code/
+WORKDIR /code/
+ADD . /code/
+
+# Install all build deps:
+RUN set -ex \
+    && apt-get update \
+    && apt-get install -y \
+        gcc \
+        libjpeg62 \
+        libjpeg62-turbo-dev \
+        libpq-dev \
+        make \
+        postgresql-client \
+    && pip install --no-cache-dir -r /code/requirements.txt
+
+# expose port
+EXPOSE 8000
+
+# Docker entrypoint:
+ENV DJANGO_MANAGEPY_MIGRATE=on \
+    DJANGO_MANAGEPY_COLLECTSTATIC=on \
+    DJANGO_MANAGEPY_UPDATEINDEX=on
+ENTRYPOINT ["/code/docker-entrypoint.sh"]
+
+# Start python runserver:
+CMD ["python", "./manage.py", "runserver", "0.0.0.0:8000"]

MANIFEST.in

@@ -0,0 +1 @@
+include *.md

README.md

@@ -0,0 +1,86 @@
+# wagtail_streamforms
+
+## General Setup
+
+1. Add wagtail_streamforms to your INSTALLED_APPS:
+
+```
+INSTALLED_APPS = [
+    ...
+    'wagtail_streamforms'
+    ...
+]
+```
+
+2. Define the form templates in your settings.py:
+
+```python
+# defaults 
+WAGTAIL_STREAMFORMS_FORM_TEMPLATES = (
+    ('streamforms/form_block.html', 'Default Form Template'),
+)
+```
+
+3. Include in your base template the javascript to handle the post and response
+
+```html
+<script src="//code.jquery.com/jquery-2.2.4.min.js"></script>
+<script src="{% static 'streamforms/js/form-handler.js' %}"></script>
+```
+
+## Enable Recaptcha
+
+Has been enabled via the [django-recaptcha](https://github.com/praekelt/django-recaptcha) package. Please note that only one recapcha should be used per page.
+
+Just add captcha to your INSTALLED_APPS:
+
+```
+INSTALLED_APPS = [
+    ...
+    'captcha'
+    ...
+]
+```
+
+and add the required keys in your settings.py which you can get from google's recapcha service:
+
+```
+RECAPTCHA_PUBLIC_KEY = 'xxx'
+RECAPTCHA_PRIVATE_KEY = 'xxx'
+ 
+# To use the new No Captcha reCaptcha
+NOCAPTCHA = True
+```
+
+## Styling Form Errors
+
+Below is an example of the css you will need to highlight the form errors:
+
+```scss
+// errors
+.has-error input,
+.has-error select,
+.has-error textarea { border-color: red; }
+ 
+.has-error label,
+.has-error .error-msg { color: red; }
+ 
+// recaptcha
+.g-recaptcha { margin-bottom: 20px; }
+```
+
+## Example Site
+
+1. Run the docker container
+
+```bash
+$ docker-compose up
+```
+
+2. Create yourself a superuser
+```bash
+$ docker exec -it <container_name> bash
+$ python manage.py createsuperuser
+```
+
+3. Go to [http://127.0.0.1:8000](http://127.0.0.1:8000)

docker-compose.yml

@@ -0,0 +1,42 @@
+version: '2'
+
+# run the app in development mode
+
+services:
+  app:
+    build: .
+    tty: true
+    volumes:
+    - .:/code
+    environment:
+    - DJANGO_MANAGEPY_COLLECTSTATIC=off
+    - DJANGO_SETTINGS_MODULE=example.settings
+    - SECRET_KEY=secret
+    - ALLOWED_HOSTS=*
+    - RDS_HOSTNAME=db
+    - RDS_PORT=5432
+    - RDS_DB_NAME=postgres
+    - RDS_USERNAME=postgres
+    - RDS_PASSWORD=password
+    - EMAIL_HOST=mail
+    - EMAIL_PORT=1025
+    depends_on:
+    - db
+    - mail
+    ports:
+    - 8000:8000
+  db:
+    image: postgres
+    environment:
+    - POSTGRES_USER=postgres
+    - POSTGRES_PASSWORD=password
+    - POSTGRES_DB=postgres
+    - PGDATA=/var/lib/postgresql/data/pgdata
+    volumes:
+    - ./.postgres:/var/lib/postgresql/data/pgdata
+    ports:
+    - 5432:5432
+  mail:
+    image: mailhog/mailhog
+    ports:
+    - 8025:8025

docker-entrypoint.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+set -e
+
+export PGPASSWORD=$RDS_PASSWORD
+
+while ! psql -h $RDS_HOSTNAME -d $RDS_DB_NAME -p $RDS_PORT -U $RDS_USERNAME -c "SELECT version();" > /dev/null 2>&1; do
+    echo 'Waiting for connection with db...'
+    sleep 1;
+done;
+echo 'Connected to db...';
+
+if [ "x$DJANGO_MANAGEPY_MIGRATE" = 'xon' ]; then
+    python manage.py migrate --noinput
+fi
+
+if [ "x$DJANGO_MANAGEPY_COLLECTSTATIC" = 'xon' ]; then
+    python manage.py collectstatic --noinput
+fi
+
+if [ "x$DJANGO_MANAGEPY_UPDATEINDEX" = 'xon' ]; then
+    python manage.py update_index
+fi
+
+exec "$@"

example/migrations/0001_initial.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.6 on 2017-10-10 00:27
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+import django.db.models.deletion
+import wagtail.wagtailcore.blocks
+import wagtail.wagtailcore.fields
+import wagtail_streamforms.blocks
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('wagtailcore', '0040_page_draft_title'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='BasicPage',
+            fields=[
+                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.Page')),
+                ('body', wagtail.wagtailcore.fields.StreamField((('form', wagtail.wagtailcore.blocks.StructBlock((('form', wagtail_streamforms.blocks.FormChooserBlock()),))),))),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=('wagtailcore.page',),
+        ),
+    ]

example/migrations/__init__.py

@@ -0,0 +1,18 @@
+from wagtail.wagtailadmin.edit_handlers import StreamFieldPanel
+from wagtail.wagtailcore.fields import StreamField
+from wagtail.wagtailcore.models import Page
+from wagtail_streamforms.blocks import WagtailFormBlock
+
+
+class BasicPage(Page):
+
+    body = StreamField([
+        ('form', WagtailFormBlock())
+    ])
+
+    # show in menu ticked by default
+    show_in_menus_default = True
+
+    content_panels = Page.content_panels + [
+        StreamFieldPanel('body'),
+    ]