diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | README.tex | 116 |
2 files changed, 2 insertions, 117 deletions
@@ -1 +1,2 @@ -auto/
\ No newline at end of file +auto/ +*.lock
\ No newline at end of file diff --git a/README.tex b/README.tex deleted file mode 100644 index e133238..0000000 --- a/README.tex +++ /dev/null @@ -1,116 +0,0 @@ -% Created 2020-02-05 Wed 15:56 -% 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} -\author{Marius P. and Vaqar S.} -\date{Created: \textit{<2020-01-22 Wed> } \break Updated: \textit{<2020-02-05 Wed>}} -\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:org077247d} - -\subsection{\texttt{Pipfile}} -\label{sec:org4222668} -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:org425064c} -This file contains checksums for the packages installed via \texttt{pipenv}. - -\subsection{\texttt{README.org}} -\label{sec:orgdff75cc} -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:orgac83665} -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:orgb2e5456} -Static files and assets do not change during the \texttt{Flask} application's execution. - -\begin{enumerate} -\item \texttt{img} -\label{sec:org7afe92f} -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:org4bfb4f4} -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:org4f7742b} -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:org691e421} -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:org18bbfe0} -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. - -\section{Prerequisites} -\label{sec:org37f495c} - -\begin{enumerate} -\item A Python interpreter and the following dependencies: -\begin{center} -\begin{tabular}{ll} -Dependency & Minimum version\\ -\hline -\texttt{flask} & \\ -\texttt{flask-wtf} & \\ -\texttt{uwsgi} & \\ -\texttt{flask-socketio} & \\ -\texttt{flask-sqlalchemy} & \\ -\texttt{psycopg2} & \\ -\end{tabular} - -\end{center} - -\item A web browser -\end{enumerate} - -\section{Installation} -\label{sec:org4f8f49c} - -\begin{enumerate} -\item Install Python -\item Install dependencies -\end{enumerate} - -\section{Viewing the website} -\label{sec:org61e9d73} - -\begin{enumerate} -\item Run the \texttt{routes.py} script using your Python interpreter. -\item Visit \texttt{127.0.0.1} on your web browser. -\end{enumerate} -\end{document} |