Moving code to github

Author: Pierre Guillemot

.gitignore

@@ -0,0 +1,3 @@
+**/*.pyc
+.vagrant/
+.secret

CHANGELOG

@@ -0,0 +1,84 @@
+# Ideas
+
+## How to
+
+ * Launch the VM and provision it: `vagrant up ideas`
+ * SSH into the VM: `vagrant ssh ideas`
+ * Load the virtualenv: `source env/bin/activate`
+ * Initialize the db: `python manage.py migrate`
+ * Launch the app: `python manage.py runserver 0.0.0.0:8000`
+ * Access the application on your host browser: http://localhost:8000/ideas for development
+ * Access the application on your host browser: http://192.168.33.10/ideas/ for production
+    * Make sure the supervisor job is running: `sudo supervisorctl start ideas`
+    * The port 80 is not forwarded to the host, so you need to use the machine IP
+ * Create a super user: `python manage.py createsuperuser`
+ * Access the DB: sudo su postgres && psql && \c ideas && \d && \q
+
+## Oauth login
+
+This application supports Facebook and Google login, you need to export the keys and secrets:
+
+```
+export IDEAS_FACEBOOK_KEY='facebook-key'
+export IDEAS_FACEBOOK_SECRET='facebook-secret'
+export IDEAS_GOOGLE_KEY='google-key'
+export IDEAS_GOOGLE_SECRET='google-secret'
+```
+
+## Webapp access
+
+The port 8000 is forwarded to the host, you HAVE to access the website using this URL: `http://localhost:8000` otherwise the login won't work
+
+## EC2 deployment
+
+## Provisioning the machine
+
+ * `ssh -i aws-key.pem [email protected]`
+ * `export AWS_ACCESS_KEY="..."`
+ * `export AWS_SECRET_KEY="..."`
+ * `ansible-playbook -i inventory --sudo playbook-ec2.yml --ask-sudo-pass`
+
+## Jenkins job
+
+This is not a best practice, as we should use parameterized jobs to deploy on different environments,
+but I am using a deployment/ folder at the root of the project, which contains 'live' configurations.
+Here is the jenkins job to deploy the application:
+
+```
+#!/bin/bash
+cd /opt/ideas
+virtualenv env --no-site-package
+source env/bin/activate
+pip install -r requirements.txt
+pip install gunicorn
+cp deployment/settings.py ideas/ideas/settings.py
+cp deployment/gunicorn_config.py env
+cd ideas
+python manage.py migrate
+sudo service nginx restart
+sudo supervisorctl restart ideas
+```
+
+## Unit tests
+
+Run the following command: `python manage.py test`
+
+## TODO
+
+### INFRA
+
+ * Enable production mode (http://stackoverflow.com/questions/5836674/why-does-debug-false-setting-make-my-django-static-files-access-fail)
+ * Use the normal workspace and THEN move the package to /opt
+ * Create parameterized builds and use templating instead of hardcoded deployment/
+ * Investigate the use of loggers (rsyslog impl)
+
+### FEATURES
+
+ * Functionnal tests (https://docs.djangoproject.com/en/1.8/intro/tutorial05/)
+ * Fix the admin pages CSS
+ * Change index title (should not be 10, but 8)
+ * Add '*' next to compulsory fields on the form page
+ * Add a cancel button (go back to previous page) on the form page
+ * Add a Delete Idea feature in the action bar of the details page
+ * Add the tag feature (postgres text array + api)
+ * Use purecss, jquery and quill libs locally (so that later we can minify them)

README

@@ -0,0 +1,26 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+VAGRANTFILE_API_VERSION = "2"
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "https://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box"
+  config.ssh.insert_key = false
+  config.vm.provider :virtualbox do |v|
+    v.name = "ideas"
+    v.memory = 1024
+    v.cpus = 2
+    v.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
+    v.customize ["modifyvm", :id, "--ioapic", "on"]
+  end
+  config.vm.hostname = "ideas"
+  config.vm.network :private_network, ip: "192.168.33.10"
+  config.vm.network "forwarded_port", guest: 8000, host: 8000
+  # Set the name of the VM. See: http://stackoverflow.com/a/17864388/100134
+  config.vm.define :ideas do |ideas|
+  end
+  # Ansible provisioner.
+  config.vm.provision "ansible" do |ansible|
+    ansible.playbook = "provisioning/playbook.yml"
+    ansible.inventory_path = "provisioning/inventory"
+    ansible.sudo = true
+  end
+end

Vagrantfile

@@ -0,0 +1,5 @@
+command = '/opt/ideas/env/bin/gunicorn'
+pythonpath = '/opt/ideas/ideas'
+bind = '127.0.0.1:8000'
+workers = 3
+user = 1000

deployment/gunicorn_config.py

@@ -0,0 +1,138 @@
+"""
+Django settings for ideas project.
+
+Generated by 'django-admin startproject' using Django 1.8.4.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.8/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.8/ref/settings/
+"""
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+import os
+
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'm_wfyp(q^!$7&p)4*p@jzhwiz-yvicsp19q&fplcbgd+2ftq(s'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+# In production, set DEBUG = False as well as the ALLOWED_HOSTS
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = (
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'social.apps.django_app.default',
+    'idea',
+    'users',
+)
+
+AUTHENTICATION_BACKENDS = (
+    'social.backends.facebook.FacebookOAuth2',
+    'social.backends.google.GoogleOAuth2',
+    'django.contrib.auth.backends.ModelBackend',
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'django.middleware.security.SecurityMiddleware',
+)
+
+ROOT_URLCONF = 'ideas.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+TEMPLATES_CONTEXT_PROCESSORS = (
+    'social.apps.django_app.context_processors.backends',
+    'social.apps.django_app.context_processors.login_redirect',
+)
+
+WSGI_APPLICATION = 'ideas.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.8/ref/settings/#databases
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql_psycopg2',
+        'NAME': 'ideas',
+        'USER': 'ideas_user',
+        'PASSWORD': 'ideas_user',
+        'HOST': 'localhost',
+        'PORT': '',
+    }
+}
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.8/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.8/howto/static-files/
+
+STATIC_URL = '/static/'
+
+STATICFILES_DIRS = (
+    os.path.join(BASE_DIR, 'static'),
+)
+
+# This URL get called when the user tries to access a URL which requires
+# authentication.
+LOGIN_URL = '/users/login'
+
+# Facebook App secret settings from the dashboard
+SOCIAL_AUTH_FACEBOOK_KEY = os.environ.get('IDEAS_FACEBOOK_KEY', '')
+SOCIAL_AUTH_FACEBOOK_SECRET = os.environ.get('IDEAS_FACEBOOK_SECRET', '')
+
+# Google App secret settings
+SOCIAL_AUTH_GOOGLE_OAUTH2_KEY = os.environ.get('IDEAS_GOOGLE_KEY', '')
+SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET = os.environ.get('IDEAS_GOOGLE_SECRET', '')
+
+USE_X_FORWARDED_HOST = True

deployment/settings.py

@@ -0,0 +1,4 @@
+from django.contrib import admin
+from idea.models import Category
+
+admin.site.register(Category)