Flask Portfolio Starter

Use this project to create a Flask Servr.

Runtime link: https://flask.nighthawkcodingsociety.com/ GitHub link: https://github.com/nighthawkcoders/flask_portfolio

Conventional way to get started

Quick steps that can be used with MacOS, WSL Ubuntu, or Ubuntu; this uses Python 3.9 or later as a prerequisite.

• Open a Terminal, clone project and cd to project area

mkdir ~/vscode; cd ~/vscode

git clone https://github.com/nighthawkcoders/flask_portfolio.git

cd flask_portfolio

• Install python dependencies for Flask, etc.

pip install -r requirements.txt

• Run from Terminal without VSCode

  • Run python from command line and check server

  python main.py

Open project in VSCode

• Prepare VSCode and run

  • From Terminal run VSCode

  code .

  Select main.py and play

Alternate way, Nix way to get started

Quick steps with MacOS, WSL Ubuntu, or Ubuntu; this uses Nix for programmatic way to build tools and dependencies. This is only recommended if you are having problems with you desktop MacOS, WSL Ubuntu, or Ubuntu.

• Open a Terminal, install nix which requires admin password:

sh <(curl -L https://nixos.org/nix/install)

• Restart Terminal

• Install Python Package helper

nix-env -if https://github.com/DavHau/mach-nix/tarball/3.5.0 -A mach-nix

• Open a Terminal, cd to project area

mkdir ~/vscode; cd ~/vscode

git clone https://github.com/nighthawkcoders/flask_portfolio.git

cd flask_portfolio

• Build nix packages from requirements.txt

mach-nix env ./env -r requirements.txt

• End of nix shell setup, exit shell

exit

Run Server or run VSCode

• Run nix shell (virtual environment)

nix-shell ./env

• Run from Terminal without VSCode

  • Run python from command line and check server

  python main.py

• Prepare VSCode and run

  • From Terminal run VSCode

  code .

  • In VSCode open Terminal, verify Nix python

  which python

  • Open Setting: Ctl-Shift P or Cmd-Shift

  • Search Python: Select Interpreter

  • Match interpreter to which output above

  • Try Play button and try to Debug

Idea

The purpose of project is to serve APIs. It is the backend piece of a Full-Stack project. Review API folder for endpoints.

Visual thoughts

The Starter code should be fun and practical.

• Organize with Bootstrap menu
• Add some color and fun through VANTA Visuals (birds, halo, solar, net)
• Show some practical and fun links (hrefs) like Twitter, Git, Youtube
• Build a Sample Page (Table)
• Show project specific links (hrefs) per page

Files and Directories in this Project

These are some of the key files and directories in this project

README.md: This file contains instructions for setting up the necessary tools and cloning the project. A README file is a standard component of all properly set up GitHub projects.

requirements.txt: This file lists the dependencies required to turn this Python project into a Flask/Python project. It may also include other backend dependencies, such as dependencies for working with a database.

main.py: This Python source file is used to run the project. Running this file starts a Flask web server locally on localhost. During development, this is the file you use to run, test, and debug the project.

Dockerfile and docker-compose.yml: These files are used to run and test the project in a Docker container. They allow you to simulate the project’s deployment on a server, such as an AWS EC2 instance. Running these files helps ensure that your tools and dependencies work correctly on different machines.

instances: This directory is the standard location for storing data files that you want to remain on the server. For example, SQLite database files can be stored in this directory. Files stored in this location will persist after web application restart, everyting outside of instances will be recreated at restart.

static: This directory is the standard location for files that you want to be cached by the web server. It is typically used for image files (JPEG, PNG, etc.) or JavaScript files that remain constant during the execution of the web server.

api: This directory contains code that receives and responds to requests from external servers. It serves as the interface between the external world and the logic and code in the rest of the project.

model: This directory contains files that implement the backend functionality for many of the files in the api directory. For example, there may be files in the model directory that directly interact with the database.

templates: This directory contains files and subdirectories used to support the home and error pages of the website.

.gitignore: This file specifies elements to be excluded from version control. Files are excluded when they are derived and not considered part of the project’s original source. In the VSCode Explorer, you may notice some files appearing dimmed, indicating that they are intentionally excluded from version control based on the rules defined in .gitignore.

Implementation Summary

July 2023

Updates for 2023 to 2024 school year.

• Update README with File Descriptions

January 2023

This project focuses on being a Python backend server. Intentions are to only have simple UIs an perhaps some Administrative UIs.

September 2021

Basic UI elements were implemented showing server side Flask with Jinja 2 capabilities.

• Project entry point is main.py, this enables Flask Web App and provides capability to renders templates (HTML files)
• The main.py is the Web Server Gateway Interface, essentially it contains a HTTP route and HTML file relationship. The Python code constructs WSGI relationships for index, kangaroos, walruses, and hawkers.
• The project structure contains many directories and files. The template directory (containing html files) and static directory (containing js files) are common standards for HTML coding. Static files can be pictures and videos, in this project they are mostly javascript backgrounds.
• WSGI templates: index.html, kangaroos.html, ... are aligned with routes in main.py.
• Other templates support WSGI templates. The base.html template contains common Head, Style, Body, Script definitions. WSGI templates often "include" or "extend" these templates. This is a way to reuse code.
• The VANTA javascript statics (backgrounds) are shown and defaulted in base.html (birds), but are block replaced as needed in other templates (solar, net, ...)
• The Bootstrap Navbar code is in navbar.html. The base.html code includes navbar.html. The WSGI html files extend base.html files. This is a process of management and correlation to optimize code management. For instance, if the menu changes discovery of navbar.html is easy, one change reflects on all WSGI html files.
• Jinja2 variables usage is to isolate data and allow redefinitions of attributes in templates. Observe "{% set variable = %}" syntax for definition and "{{ variable }}" for reference.
• The base.html uses combination of Bootstrap grid styling and custom CSS styling. Grid styling in observe with the "" markers. A Bootstrap Grid has a width of 12, thus four "Col-3" markers could fit on a Grid row.
• A key purpose of this project is to embed links to other content. The "href=" definition embeds hyperlinks into the rendered HTML. The base.html file shows usage of "href={{github}}", the "{{github}}" is a Jinja2 variable. Jinja2 variables are pre-processed by Python, a variable swap with value, before being sent to the browser.