Team Style Guide - ZacharyJoswick/CodeRx GitHub Wiki

Team 01 Style Guide

Our application will be built using a combination of Flask (A python framework), Javascript (for the frontend), Jinja (for base web page elements), and Docker (for deployment and development environments). Each of these languages have different syntax and style guides. To reduce redundancy, this page will only link to external style guides rather than replicating their information here.

Flask

For flask we will follow the explore flask style guide (which in turn follows PEP-8 and PEP-257). This guide can be found here.

Jinja

Jinja is the template engine used to create dynamic forms for CodeRx. We will follow the chromium style guide located here.

Javascript

Javascript will be used in the frontend for interactive elements. There are many competing style guides, but we will be following the google javascript style guide located here.

Docker

Docker will be used for the development and deployment of our software. It will ensure that we have consistent testing and deployment environments. We will use the Hauef-Lexware dockerfile style guide shown here.