Merge branch 'vuLgAr-cookiecutter'

Author: mjhea0

.travis.yml

@@ -6,6 +6,9 @@ python:
   - "3.4"
   - "2.7"
 
+before_install: 
+  - "cd {{cookiecutter.app_slug}}"
+
 install:
   - "pip install pipenv"
   - "pipenv install --dev"

README.md

@@ -8,21 +8,25 @@ Flask starter project...
 
 ### Basics
 
+1. cd into the `{{cookiecutter.app_slug}}` directory.
 1. Create and activate a virtualenv
 1. Install the requirements
 
+
 ### Set Environment Variables
 
 Update *project/server/config.py*, and then run:
 
 ```sh
+$ export APP_NAME="Flask Skeleton"
 $ export APP_SETTINGS="project.server.config.DevelopmentConfig"
 $ export FLASK_DEBUG=1
 ```
 
 Using pipenv or python-dotenv? Use the *.env* file to set environment variables:
 
 ```sh
+APP_NAME="Flask Skeleton"
 APP_SETTINGS="project.server.config.DevelopmentConfig"
 FLASK_DEBUG=1
 ```
@@ -59,3 +63,19 @@ With coverage:
 ```sh
 $ python manage.py cov
 ```
+
+### Cookiecutter Template
+
+Alternatively you can use the cookiecutter template.
+
+First, get Cookiecutter:
+
+```sh
+$ pip install cookiecutter
+```
+
+Now run it against this repo:
+
+```sh
+$ cookiecutter https://github.com/realpython/flask-skeleton.git
+```

cookiecutter.json

@@ -0,0 +1,7 @@
+{
+    "app_name": "Flask Skeleton",
+    "app_slug": "{{ cookiecutter.app_name.lower()|replace(' ', '_')|replace('-', '_') }}",
+    "_copy_without_render": [
+        "*.html"
+    ]
+}

.env renamed to {{cookiecutter.app_slug}}/.env

@@ -1,2 +1,3 @@
+APP_NAME="{{cookiecutter.app_name}}"
 APP_SETTINGS="project.server.config.DevelopmentConfig"
 FLASK_DEBUG=1