Skip to content

Commit 007135a

Browse files
committed
Add appendix explanation on running the tool & guide
1 parent 69cfd92 commit 007135a

File tree

1 file changed

+76
-1
lines changed

1 file changed

+76
-1
lines changed

chapters/appendixA.tex

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,79 @@
22
\chapter{Project Instructions}
33
\label{AppendixA}
44

5-
The CD is formed of three directories
5+
The CD is formed of three directories:
6+
\begin{itemize}
7+
\item src - This contains the raw code for the deliverables pulled straight
8+
from github each project contains a README on how to build and execute it.
9+
Both have a prerequisite on npm or yarn and an internet connection if you
10+
wish to install them on your local pc.
11+
\item build - This contains built versions of the deliverables which can be
12+
hosted on a static HTTP server. It is important to note that they must be
13+
hosted at the root directory. Opening index.html for each in a browser will
14+
give you the full content.
15+
\begin{itemize}
16+
\item A11Y Guide - This is also available at
17+
\item A11Y Tool -
18+
\end{itemize}
19+
\item report - This contains the report
20+
\end{itemize}
21+
22+
\section{Viewing prebuilt artifacts}
23+
\subsection{A11Y Guide}
24+
There are few different methds for viewing the artifacts.
25+
26+
\subsubsection{View the version from Continuous Deployment}
27+
It is available at: \url{https://geeman201.github.io/geemans-a11y-guide}
28+
with the source being available at: \url{https://github.com/Geeman201/geemans-a11y-guide}
29+
30+
\subsubsection{Using a PHP server}
31+
\begin{enumerate}
32+
\item Navigate to the build/A11Y-Guide directory
33+
\item If you have PHP install execute 'php -S localhost:8000'
34+
\item Navigate to localhost:8080/
35+
\end{enumerate}
36+
37+
\subsubsection{Using a node server}
38+
\begin{enumerate}
39+
\item Navigate to the build/A11Y-Guide directory
40+
\item Install a server using 'npm install -g serve'
41+
\item Execute 'serve -s .'
42+
\item Navigate to localhost:5000/
43+
\end{enumerate}
44+
45+
\subsection{A11Y Tool}
46+
To demonstrate the tools capability included is html file which allows runs
47+
the tests against itself.
48+
\subsubsection{Through an example page}
49+
\begin{enumerate}
50+
\item Follow the instructions above to start HTTP server but in the
51+
build\\A11Y-Tool directory
52+
\item Open a browser
53+
\item Navigate to localhost:5000/
54+
\item If you observe a page loading with a report in the top right corner it
55+
is successfully working.
56+
\end{enumerate}
57+
58+
\subsubsection{Inject it via the devtools}
59+
\begin{enumerate}
60+
\item Follow the instructions above to start HTTP server but in the
61+
build\\A11Y-Tool directory
62+
\item Open a browser
63+
\item Open the browsers devtools
64+
\item Execute the command shown below to insert a script element pointing at
65+
the deployed instance
66+
\item Observe the tool running against your page
67+
\end{enumerate}
68+
69+
\begin{lstlisting}
70+
(function(){var head=document.getElementsByTagName('head')[0],script=document
71+
.createElement('script');script.type='text/javascript';script
72+
.src='http://localhost:8000/static/js/main.3d588863.js';head.appendChild
73+
(script);})();
74+
\end{lstlisting}
75+
76+
77+
\section{Building Artifacts}
78+
Both artifacts are built using yarn and npm and thus going into their
79+
retrospective directories and running either `yarn build' or `npm run build'
80+
will result in the project building a fresh version.

0 commit comments

Comments
 (0)