From e5b4cf0f660b9528aea3ad470d1961f095f9bdfe Mon Sep 17 00:00:00 2001 From: "Eric S. Bullington" Date: Tue, 6 Mar 2012 13:31:53 -0500 Subject: [PATCH] Added README, LICENSE, and TODO --- LICENSE | 15 +++++++++++++++ README | 31 +++++++++++++++++++++++++++++++ TODO | 4 ++++ 3 files changed, 50 insertions(+) create mode 100644 LICENSE create mode 100644 TODO diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9657485 --- /dev/null +++ b/LICENSE @@ -0,0 +1,15 @@ +##Flask-Tool Copyright 2012 Lucas Hrabovsky + +##Bootstrap Copyright 2012 Twitter + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README b/README index e69de29..8c5734b 100644 --- a/README +++ b/README @@ -0,0 +1,31 @@ +# flask-bootstrap + +Flask application framework pre-configured for SQL Alchemy, flask-auth authentication, and Twitter bootstrap frontend. +Based on Flask Tool's simple app template by imlucas and Twitter's bootstrap framework. + +## Install + git clone git://github.com/esbullington/flask-bootstrap.git + cd flask-bootstrap + pip install -r requirements.txt + +## Run the app locally + + +## Deploy to AWS + +Change the appropriate settings in fabfile.py and + fab deploy + + +## Features + +* Default templates with HTML5 Boilerplate included +* Ready to go manage.py that uses the excellent Flask-Script package +* Supervisord config to run your app on uwsgi +* Nginx config and required dependencies +* Pre built fabfile for deployment on ec2 via Fabric +* Base requirements.txt +* Bootstrap frontend framework from Twitter + + + diff --git a/TODO b/TODO new file mode 100644 index 0000000..896c323 --- /dev/null +++ b/TODO @@ -0,0 +1,4 @@ +##TO DO + +* Set up default user authorization for admin user (authentication has already been setup using flask-auth) +* Integrate some sort of Python asset manager for static assets (i.e., JS/CSS minifier, file concatenator), ideally one that compiles CoffeeScript