diff options
| -rw-r--r-- | README.org | 38 | ||||
| -rw-r--r-- | README.pdf | bin | 0 -> 169263 bytes | |||
| -rw-r--r-- | README.tex | 79 |
3 files changed, 116 insertions, 1 deletions
@@ -1 +1,37 @@ -# yesno +#+TITLE: README.org for =yesno= +#+AUTHOR: Marius P. and Vaqar S. +#+DATE: 22 Jan. 2020 +#+LATEX_HEADER: \usepackage{fullpage} + +* Folder structure + +** =Pipfile= + Inspecting this file reveals the Python dependencies required by the Flask application. + The convenient =pipenv= Python package bundles together the creation of virtual environments and populating these virtual environments using the same commands as =pip=. For more information on =pipenv=, visit [[https:github.com/pypa/pipenv][the official pipenv page]]. + +** =Pipfile.lock= + This file contains checksums for the packages installed via =pipenv=. + +** =README.org= + This is the file you are currently reading. Github automatically formats README files and presents underneath the code explorer. + +** =app= directory + Contains =.py= Python scripts calling the =Flask= library in order to serve web pages to the end user. + +*** =static= + Static files and assets do not change during the =Flask= application's execution. + +**** =img= + This is where website images are saved. User images will be stored in a database, which is currently not implemented. + +**** =styles= + Here, we store =CSS= style sheets. These contain appearance information for elements described in =HTML= documents. + +*** =templates= + In the templates folder, we organise our =HTML= templates. Rather than simple =HTML= documents which always present the same content to all users, templates are rendered to the user's browser by the application and are populated during loading with content we can request via the Python application. + +*** =routes.py= + This Python file containes our website routes. These are the names of our website's pages, followed by functions describing actions performed on the server side every time a user visits a certain page. + +*** =forms.py= + This Python file contains the forms that our user will sign in throughout the website (registration, login). Possible implementation of the messaging system as a series of forms sent from user to user. diff --git a/README.pdf b/README.pdf Binary files differnew file mode 100644 index 0000000..07be55f --- /dev/null +++ b/README.pdf diff --git a/README.tex b/README.tex new file mode 100644 index 0000000..fb73f05 --- /dev/null +++ b/README.tex @@ -0,0 +1,79 @@ +% Created 2020-01-22 Wed 19:35 +% Intended LaTeX compiler: pdflatex +\documentclass[11pt]{article} +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{graphicx} +\usepackage{grffile} +\usepackage{longtable} +\usepackage{wrapfig} +\usepackage{rotating} +\usepackage[normalem]{ulem} +\usepackage{amsmath} +\usepackage{textcomp} +\usepackage{amssymb} +\usepackage{capt-of} +\usepackage{hyperref} +\usepackage{fullpage} +\author{Marius P. and Vaqar S.} +\date{22 Jan. 2020} +\title{README.org for \texttt{yesno}} +\hypersetup{ + pdfauthor={Marius P. and Vaqar S.}, + pdftitle={README.org for \texttt{yesno}}, + pdfkeywords={}, + pdfsubject={}, + pdfcreator={Emacs 26.3 (Org mode 9.2.6)}, + pdflang={English}} +\begin{document} + +\maketitle +\tableofcontents + + +\section{Folder structure} +\label{sec:org4938adb} + +\subsection{\texttt{Pipfile}} +\label{sec:orgd7f1aa1} +Inspecting this file reveals the Python dependencies required by the Flask application. +The convenient \texttt{pipenv} Python package bundles together the creation of virtual environments and populating these virtual environments using the same commands as \texttt{pip}. For more information on \texttt{pipenv}, visit \href{https:github.com/pypa/pipenv}{the official pipenv page}. + +\subsection{\texttt{Pipfile.lock}} +\label{sec:org27c90c7} +This file contains checksums for the packages installed via \texttt{pipenv}. + +\subsection{\texttt{README.org}} +\label{sec:org87e8b71} +This is the file you are currently reading. Github automatically formats README files and presents underneath the code explorer. + +\subsection{\texttt{app} directory} +\label{sec:org8b8aa68} +Contains \texttt{.py} Python scripts calling the \texttt{Flask} library in order to serve web pages to the end user. + +\subsubsection{\texttt{static}} +\label{sec:org75f3ff4} +Static files and assets do not change during the \texttt{Flask} application's execution. + +\begin{enumerate} +\item \texttt{img} +\label{sec:org227be90} +This is where website images are saved. User images will be stored in a database, which is currently not implemented. + +\item \texttt{styles} +\label{sec:org52a88e7} +Here, we store \texttt{CSS} style sheets. These contain appearance information for elements described in \texttt{HTML} documents. +\end{enumerate} + +\subsubsection{\texttt{templates}} +\label{sec:org24e0e72} +In the templates folder, we organise our \texttt{HTML} templates. Rather than simple \texttt{HTML} documents which always present the same content to all users, templates are rendered to the user's browser by the application and are populated during loading with content we can request via the Python application. + +\subsubsection{\texttt{routes.py}} +\label{sec:orgc4dc0be} +This Python file containes our website routes. These are the names of our website's pages, followed by functions describing actions performed on the server side every time a user visits a certain page. + +\subsubsection{\texttt{forms.py}} +\label{sec:orgb8c7f76} +This Python file contains the forms that our user will sign in throughout the website (registration, login). Possible implementation of the messaging system as a series of forms sent from user to user. +\end{document} |