A simple Python Flask bootstrapper
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Trevor Richards efa66d025d update clone url 3 years ago
routes Refactor to use factories 3 years ago
sass Initial Commit 3 years ago
static Initial Commit 3 years ago
tmp Initial Commit 3 years ago
views Initial Commit 3 years ago
.gitignore update .gitignore 3 years ago
config.py Refactor to use factories 3 years ago
factory.py Refactor to use factories 3 years ago
launcher.py if name == '__main__' 3 years ago
passenger_wsgi.py Refactor to use factories 3 years ago
readme.md update clone url 3 years ago
requirements.txt Initial Commit 3 years ago

readme.md

Flask Starter Web Application

What's included

In this repo is flask web-app skeleton for a basic API or Flask powered website. The stylesheets are Sassy and Bootstrap 4 is included in the Sass libs folder. Everything you need here (except a Sass precompiler) to get started with a Flask App along with deployment instructions for Dreamhost.

See this project live here

Requirements

  • Python (preferrably Python3)
  • pip package manager
  • Virtualenv for managing virtual environments (installed via pip)
  • SASS/SCSS compiler (or not, it's up to you. My SASS files are included in the repo.)

Instructions

Installation

  1. Clone this repository
git clone ssh://git@git.trevdev.ca:10022/trevdev/flask-starter.git
  1. Enter the flask-starter directory
  2. Setup your virtual environment (virtualenv) and activate your env.
virtualenv env
source ./env/bin/activate
  1. When you see the little (env) indicator on your terminal, install the python package dependancies.
pip install -r requirements.txt
  1. Launch the app and preview it in your browser on localhost:5000.
python launcher.py
  1. Edit/change/develop your site using Flask + Jinja2 (Or whatever other templating you wish to use)

Deployment (Dreamhost)

  1. Setup hosting for a domain and ensure you have passenger enabled for Python apps.
  2. Use FTP/SFTP to move your project to its destination on Dreamhost (/home/username/example.com). Be sure to avoid moving any caching or your env.
  3. Use a secure shell to log in to your dreamhost hosting and run the same steps to setup your pip and virtualenv. If your python is out of date on Dreamhost, you can update it/install your own version.
  4. Configure passenger_wsgi.py to tie-in passenger to your application - specifically the destination of the python file inside ./env/bin/python. You'll need to change the "website" and username in the INTERP string.
import sys, os

INTERP = '/home/<username>/<website.com>/env/bin/python'
if sys.executable != INTERP:
    os.execl(INTERP, INTERP, *sys.argv)
sys.path.append(os.getcwd())

from app import app as application
  1. Wait a few minutes, then visit your website. It should be working. If not, Dreamhost has lots of documentation/support that can help you out. Enjoy!