A quick and dirty Flask app that is designed to be deployed to Heroku. This repository is a template repository and is designed to be a launching off point for people looking to write flask apps that work with heroku.
If you have never used a template repository before check out the information on how to here
The base demo does have a developed structure with template variables and some of the standard metadata added, but feel free to get rid of all of this if it dosent work for you.
- Python 3
- Pip for python 3
- Install dependencies: This can be done running the following command from the root folder:
pip3 install -r requirements.txt
- Running: Run the default app using the following command from the root folder
python3 routes.py
- Begin developing your app, the simplest way is to just build a static HTML app inside the static folder.
Once you have built out your app and pushed it to github you can deploy it automatically using the button at the bottom of this readme (as long as you kept the app.json file)
*comming soon...*
I have split the explanation into sections to make it easier to understand.
.gitignore; A preconfigured gitignore file for flask. (info on .gitignore files can be found here: https://www.atlassian.com/git/tutorials/saving-changes/gitignore)
LICENSE; The liscence for the repository, in this case i'm using MIT
readme.md; The document you are currently reading, contains all the important info about usage of this repository
routes.py; Contains all routing information, as well as an important snippet about getting the external port from an environment variable. This portion of the code (found on line 11) is essential to the app working on Heroku.
requirements.txt; Marks all the dependencies necessary to run the app.
This is the folder that contains all the HTML CSS and Javascript for the default 'app', the breakdown for the subfolders is found below
boostrap: This folder contains all the files for bootstrap, a library that allows you to build responsive html apps/websites. Details on the library can be found here: https://getbootstrap.com/
css: This contains all the CSS for the default app, feel free to re-use the folder with your own styles or mess around with the default ones.
fonts: Contains all the font files needed for the icons, and pages of the default app.
img: Contains all the images necesary for the default app.
js: Contains all the javascript (minus bootstrap) necesary for the default app.
templates: Contains all the html files that are routed to from routes.py
manifest.json: Allows the default app to be PWA compliant, more details can be found here: https://developers.google.com/web/fundamentals/web-app-manifest/
Procfile; Where you specify what you want Heroku to run. Keep in mind that only services marked as web services have access to external ports.
App.json; Provides some metadata to Heroku, and allows for the single click deploy button found below.
runtime.txt; Allows you to specify a python version that heroku will run your app with.
Once you have created your own app you can just click here to deploy from your repo
