148 lines
3.7 KiB
TeX
148 lines
3.7 KiB
TeX
%! TeX program = lualatex
|
|
\documentclass[a4paper,11pt]{report}
|
|
% packages
|
|
\usepackage{censor}
|
|
\StopCensoring
|
|
\usepackage{fontspec}
|
|
\setmainfont{EB Garamond}
|
|
% for tironian et fallback
|
|
% % \directlua{luaotfload.add_fallback
|
|
% % ("emojifallback",
|
|
% % {"Noto Serif:mode=harf"}
|
|
% % )}
|
|
% % \setmainfont{EB Garamond}[RawFeature={fallback=emojifallback}]
|
|
|
|
\setmonofont[Scale=MatchLowercase]{Deja Vu Sans Mono}
|
|
\usepackage[a4paper,left=2cm,right=2cm,top=\dimexpr15mm+1.5\baselineskip,bottom=2cm]{geometry}
|
|
\setlength{\parindent}{0pt}
|
|
|
|
\usepackage{fancyhdr} % Headers and footers
|
|
\fancyhead[R]{\normalfont \leftmark}
|
|
\fancyhead[L]{}
|
|
\pagestyle{fancy}
|
|
|
|
\usepackage{microtype} % Slightly tweak font spacing for aesthetics
|
|
\usepackage[english]{babel} % Language hyphenation and typographical rules
|
|
\usepackage{xcolor}
|
|
\definecolor{linkblue}{RGB}{0, 64, 128}
|
|
\usepackage[final, colorlinks = false, urlcolor = linkblue]{hyperref}
|
|
% \newcommand{\secref}[1]{\textbf{§~\nameref{#1}}}
|
|
\newcommand{\secref}[1]{\textbf{§\ref{#1}~\nameref{#1}}}
|
|
|
|
\usepackage{changepage} % adjust margins on the fly
|
|
|
|
\usepackage{minted}
|
|
\usemintedstyle{algol_nu}
|
|
|
|
\usepackage{pgfplots}
|
|
\pgfplotsset{width=\textwidth,compat=1.9}
|
|
|
|
\usepackage{caption}
|
|
\newenvironment{code}{\captionsetup{type=listing}}{}
|
|
\captionsetup[listing]{skip=0pt}
|
|
\setlength{\abovecaptionskip}{5pt}
|
|
\setlength{\belowcaptionskip}{5pt}
|
|
|
|
\usepackage[yyyymmdd]{datetime}
|
|
\renewcommand{\dateseparator}{--}
|
|
|
|
\usepackage{enumitem}
|
|
|
|
\usepackage{titlesec}
|
|
|
|
\author{Andrew Hayes}
|
|
|
|
\begin{document}
|
|
\begin{titlepage}
|
|
\begin{center}
|
|
|
|
% University Logo
|
|
\includegraphics[width=0.8\textwidth]{./images/Logo-UGalway-2-3166136658.jpg} \\[1cm]
|
|
|
|
% Title
|
|
{\Huge \textbf{Iompar: Live Public Transport Tracking}} \\[0.5cm]
|
|
|
|
% Department and Degree
|
|
{\Large College of Science \& Engineering} \\[0.3cm]
|
|
{\large Bachelor of Science (Computer Science \& Information Technology)} \\[0.5cm]
|
|
|
|
% Report Type
|
|
{\large \textbf{Project Report}} \\[1.5cm]
|
|
|
|
% Author Section
|
|
{\Large \textbf{Author:}} \\[0.2cm]
|
|
{\large Andrew Hayes \\ 21321503 } \\[1cm]
|
|
|
|
% Supervisor Section
|
|
{\Large \textbf{Academic Supervisor:}} \\[0.2cm]
|
|
{\large Dr. Adrian Clear} \\[1.5cm]
|
|
|
|
% Date
|
|
{\Large \today}
|
|
|
|
\end{center}
|
|
\end{titlepage}
|
|
|
|
\pagenumbering{roman}
|
|
\newpage
|
|
\tableofcontents
|
|
\newpage
|
|
\setcounter{page}{1}
|
|
\pagenumbering{arabic}
|
|
|
|
% yap about mental models with regards to how filters work
|
|
% trying to make the application work the same way the user expects it to work
|
|
|
|
\chapter{Introduction}
|
|
\section{Project Overview}
|
|
\subsection{Problem Statement}
|
|
\subsection{Background}
|
|
\section{Document Structure}
|
|
|
|
\chapter{Research}
|
|
\section{Introduction}
|
|
\section{Data Sources}
|
|
\section{Similar Services}
|
|
\section{Technologies}
|
|
\subsection{Frontend Technologies}
|
|
\subsection{Backend Technologies}
|
|
\subsection{Project Management Technologies}
|
|
\section{Conclusion}
|
|
|
|
\chapter{Requirements}
|
|
\section{Functional Requirements}
|
|
\section{Non-Functional Requirements}
|
|
\section{Use Cases}
|
|
\section{Constraints}
|
|
|
|
\chapter{Design}
|
|
\section{Backend Design}
|
|
\subsection{Database Design}
|
|
\subsection{API Design}
|
|
\section{Frontend Design}
|
|
|
|
\chapter{Development}
|
|
\section{Introduction}
|
|
\section{Backend Development}
|
|
\section{Frontend Development}
|
|
\section{Development Considerations}
|
|
|
|
\chapter{Code Quality}
|
|
\section{Introduction}
|
|
\section{Clean Coding Principles}
|
|
\section{Unit Testing}
|
|
\section{CI/CD}
|
|
\subsection{Continuous Integration}
|
|
\subsection{Continuous Deployment}
|
|
|
|
\chapter{Conclusion}
|
|
\section{Evaluation}
|
|
\section{Reflection on Requirements}
|
|
\section{Reflection on Skill Development}
|
|
\section{Potential Future Work}
|
|
|
|
|
|
|
|
|
|
\end{document}
|