patrickjwolf / web-app-starter-flask

An example web application, built in Python with the Flask package, and deployed to a Heroku server.

Web App Starter Repo (Flask)

An example web application, built in Python with the Flask package, for educational purposes.

Installation

Fork the repository from GitHub source.

Then use GitHub Desktop or the command-line to "clone" or download your fork onto your local computer:

git clone https://github.com/YOUR_USERNAME/web-app-starter-flask.git # this is the HTTP address, but you could alternatively use the SSH address

Navigate into your local repo from the command-line before running any of the other commands below:

cd web-app-starter-flask

Setup

Create and activate an Anaconda virtual environment:

conda create -n web-starter-env python=3.7 # first time only
conda activate web-starter-env

NOTE: Subsequent commands assume you're running them from within the virtual environment, in the root directory of the repository.

Install package dependencies (first time only):

pip install -r requirements.txt

Usage

Run a local web server, then view your app in a browser at http://localhost:5000/:

FLASK_APP=web_app flask run

NOTE: you can quit the server by pressing ctrl+c at any time. If you change a file, you'll likely need to restart the server for the changes to take effect.

Deploying

First, install the Heroku CLI, and make sure you can login and list your applications. Then create a new application server, optionally specifying a name (e.g. "web-app-starter-flask"):

heroku login

heroku apps:list
heroku apps:create web-app-starter-flask # or do this from the online console
heroku apps:list

Then associate this repository with that application, as necessary:

git remote -v
heroku git:remote -a web-app-starter-flask # necessary if you created the app from the online console
git remote -v

After this configuration process is complete, you should be able to "deploy" the application's source code to the Heroku server:

git push heroku master

Licence