Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 41 lines (28 sloc) 2.06 kB
2def77a @swaroopch README-driven development
authored
1 h1. Flask Boilerplate Project
2
3 h2. Introduction
4
6f99126 @swaroopch [README] Minor tweaks
authored
5 I wanted a super-quick way to create new websites with all my favorite code settings and customizations. Hence, I created this boilerplate project based on the "Flask (Python) microwebframework":http://flask.pocoo.org.
2def77a @swaroopch README-driven development
authored
6
07b3e30 @swaroopch Tweaks to README
authored
7 Why Flask-Boilerplate? Because you get:
2def77a @swaroopch README-driven development
authored
8
6f99126 @swaroopch [README] Minor tweaks
authored
9 # Good code defaults - for example, (1) it uses "packages and modules":http://flask.pocoo.org/docs/patterns/packages/ by default so that controllers and models are organized into a standard directory structure and split into multiple files, (2) it merges and compresses your various CSS files into one, your multiple JS files into one, for performance reasons. And so on.
b9d336e @swaroopch [README] Updated wordings
authored
10 # New Project script - sets up everything for you right from generating the secret key (for secure cookies) to integrating memcache (including mimicing @Rails.cache.fetch@ with helpers).
6f99126 @swaroopch [README] Minor tweaks
authored
11 # Deploy to a Ubuntu server with a single command - sets up everything for you, including @virtualenv@, etc.
07b3e30 @swaroopch Tweaks to README
authored
12 #* NOTE: The installation script works specifically for Ubuntu Linux, Apache, mod_wsgi only.
6f99126 @swaroopch [README] Minor tweaks
authored
13 # jQuery - no webapp is complete without it.
14 # Grid system, via the "960 Grid System":http://960.gs - so that you can get started with your UI quickly.
15 # HTML5 goodness, via "HTML5 Boilerplate":http://html5boilerplate.com - for a good base UI.
2def77a @swaroopch README-driven development
authored
16
17 h2. Get Started
18
65b249c @swaroopch Updating README
authored
19 @git clone git://github.com/swaroopch/flask-boilerplate.git mynewapp@
20 @cd mynewapp@
21 @pip install Fabric@
ad07a33 @swaroopch Splitting code_init and env_setup
authored
22 @fab code_init:mynewapp.com@
23 @fab env_setup@
65b249c @swaroopch Updating README
authored
24 Write your code in @flask_application/controllers/frontend.py@
f27d06b @tescalada fix typo 'fab serve' -> 'fab server'
tescalada authored
25 @fab server@
2def77a @swaroopch README-driven development
authored
26
27 When you're ready to deploy your code to a server:
28
65b249c @swaroopch Updating README
authored
29 @fab server_setup@ # once per server
30 @fab deploy@
2def77a @swaroopch README-driven development
authored
31
ad07a33 @swaroopch Splitting code_init and env_setup
authored
32 When you clone a repo and want to run it:
33
34 @fab env_setup@
f27d06b @tescalada fix typo 'fab serve' -> 'fab server'
tescalada authored
35 @fab server@
ad07a33 @swaroopch Splitting code_init and env_setup
authored
36
2def77a @swaroopch README-driven development
authored
37 h2. Also See
38
6f99126 @swaroopch [README] Minor tweaks
authored
39 * "Mobile browser detection":https://github.com/shichuan/mobile-html5-boilerplate/wiki/Server-side-redirection-script to redirect users to a version of the website that uses the "Mobile HTML5 Boilerplate":http://html5boilerplate.com/mobile/.
40 * API wrapper like "simpleapi":https://github.com/flosch/simpleapi.
Something went wrong with that request. Please try again.