Skip to content
This repository has been archived by the owner on Sep 15, 2021. It is now read-only.

Latest commit

 

History

History
145 lines (85 loc) · 5.57 KB

README.md

File metadata and controls

145 lines (85 loc) · 5.57 KB
Raw

Skeleton is a Python Flask template.

It is a simple Flask application with Twitter Bootstrap and other front end development utilities. Flask enables Less and Coffeescript asset compilation through webassets and Twitter Bootstrap is included for fast frontend development.

Installation

1. Checkout this repository from git

git clone https://github.com/peterhil/skeleton skeleton-git

2. Make sure a Python version greater than or equal to 2.6 is installed

Most Linux distributions come with Python already installed, if not see the Python documentation for instructions on how to install Python.

3. Install the system requirements

Important if installing on a server behind a proxy:

  • Use sudo with the -E option to keep the http_proxy and https_proxy environment variables or alternatively also add these environment variables into the root user’s .bashrc. For example:

    export HTTP_PROXY="http://proxy"
export HTTPS_PROXY="https://proxy"
export FTP_PROXY="ftp://proxy"

  • Make npm use HTTP instead of HTTPS and/or relax it’s SSL check by using both or one of these settings, see npm issue #2472:

    npm config set registry=http://registry.npmjs.org/
npm config set strict-ssl false

  • Make git use https:// protocol instead of git:// to make it work behind a proxy:

    git config --global url."https://".insteadOf git://

Installing up to date pip and setuptools on Fedora:

sudo -E yum install python-pip
sudo -E python-pip install -U pip
sudo -E pip install -U setuptools  # To get >=0.7 setuptools, preferably >=2.1.0

Install the dependencies:

Command port refers to using Macports on Mac OS X. If you are using a different operating system, replace the port command with your system’s package manager (for example apt-get or yum) on all commands below:

sudo easy_install pip
sudo pip install virtualenv
sudo port install node  # <-- replace port with the command for your package manager
sudo npm install -g bower
sudo npm install -g less
sudo npm install -g grunt-cli

4. Install Python into virtualenv and install Python dependencies with pip

cd skeleton-git
virtualenv -p python2.7 --no-site-packages venv/py27
source ./venv/py27/bin/activate

# Install the application's Python package and dependencies with pip
pip install .

# Alternatively install using standard python installation
python setup.py install

Note! An activated virtualenv can be deactivated with:

deactivate

5. Install the node components

cd skeleton-git
npm install
bower install
cd app/static/vendor/modernizr && ./bin/modernizr >/dev/null && cd -

6. Start the app

Note! These steps should also work with just npm start.

cd skeleton-git
source ./activate  # <-- Adds some node components into the path and activates the virtualenv
python run.py
open http://localhost:5000/  # or: open http://skeleton.dev/ if using nginx and have set hosts

Configuration

The application’s default settings can be found on app/settings.py.

These can be overridden by copying the defaut settings file to instance/settings.py. Edit that file to suit your needs, and drop unmodified values to prevent shadowing the default settings.

At minimum you should set SECRET_KEY to some unguessable and randomish value. You might also want to set SERVER_NAME to match your development server address (possibly with a port number).

For a more fine detailed configuration, see the list of built-in settings on Flask documentation.

Some of these settings are exported to front end from the route /config.json at app/frontend/views.py and are available from Javascript at app.config with the keys lower cased.

Nginx as a reverse proxy

On production and maybe even on development, you should set up Nginx as a reverse proxy to your application or use some other Flask production deployment option. See docs/nginx.md on how to do that.

Development

When doing development, link a Python egg to sources instead of installing a package:

python setup.py develop

Using YAML for fixtures

To import YAML data, do import YAML on views.py and use like this:

@app.route('/example')
@templated()
def example():
    with file('app/data/example.yml', 'r') as stream:
        data = yaml.load(stream)
    return dict(examplelist=data)

Contact

License

Copyright (c) 2014 Peter hillerström This software is licensed under the MIT License. See LICENSE for details.

Credits

Following libraries are used: