Files
fyp/report/report.tex
2025-03-18 10:21:27 +00:00

154 lines
3.9 KiB
TeX

%! TeX program = lualatex
\documentclass[a4paper,11pt]{article}
% 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}
\hrule
\vspace*{0.6cm}
\Huge \textsc{ct413}
\vspace*{0.6cm}
\hrule
\LARGE
\vspace{0.5cm}
Final Report
\vspace{0.5cm}
\hrule
\vfill
\hrule
\begin{minipage}{0.495\textwidth}
\vspace{0.4em}
\raggedright
\normalsize
\begin{tabular}{@{}l l}
Name: & Andrew Hayes \\
Student ID: & 21321503 \\
% E-mail: & \href{mailto://a.hayes18@universityofgalway.ie}{a.hayes18@universityofgalway.ie} \\
Programme: & 4BCT
\end{tabular}
\end{minipage}
\begin{minipage}{0.495\textwidth}
\raggedleft
\vspace*{0.8cm}
\Large
\today
\vspace*{0.6cm}
\end{minipage}
\medskip\hrule
\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
\section{Introduction}
\subsection{Project Overview}
\subsubsection{Problem Statement}
\subsubsection{Background}
\subsection{Document Structure}
\section{Research}
\subsection{Introduction}
\subsection{Data Sources}
\subsection{Similar Services}
\subsection{Technologies}
\subsubsection{Frontend Technologies}
\subsubsection{Backend Technologies}
\subsubsection{Project Management Technologies}
\subsection{Conclusion}
\section{Requirements}
\subsection{Functional Requirements}
\subsection{Non-Functional Requirements}
\subsection{Use Cases}
\subsection{Constraints}
\section{Design}
\subsection{Backend Design}
\subsubsection{Database Design}
\subsubsection{API Design}
\subsection{Frontend Design}
\section{Development}
\subsection{Introduction}
\subsection{Backend Development}
\subsection{Frontend Development}
\subsection{Development Considerations}
\section{Code Quality}
\subsection{Introduction}
\subsection{Clean Coding Principles}
\subsection{Unit Testing}
\subsection{CI/CD}
\subsubsection{Continuous Integration}
\subsubsection{Continuous Deployment}
\section{Conclusion}
\subsection{Evaluation}
\subsection{Reflection on Requirements}
\subsection{Reflection on Skill Development}
\subsection{Potential Future Work}
\end{document}