feat: update docs to add more common issues and landing page
Some checks failed
Deploy to Production / Deploy to Production (push) Has been cancelled

This commit is contained in:
sBubshait 2025-08-07 12:19:39 +03:00
parent f5f285a1ba
commit 999947f559
2 changed files with 22 additions and 0 deletions

Binary file not shown.

View File

@ -194,6 +194,15 @@ The database schema is shown below.
\captionof{figure}{Database Schema}
\end{center}
\newpage
\subsection{Landing Page}
The landing page of the Wesal application is a simple and elegant page that provides an overview of the application and its features. It is designed to be visually appealing and easy to navigate. A screenshot of the landing page is shown below.
\begin{center}
\includegraphics[width=0.8\textwidth]{landingPage.png}
\captionof{figure}{Landing Page}
\end{center}
\newpage
\section{Installation and Setup}
\subsection{Source Code}
@ -540,6 +549,19 @@ This most of the times happen when the token has expired but Flutter for some re
Make sure you have followed the installation steps in this guide as both the front end and backend require a Service Account from Google Firebase to work. If was working but stopped working that is because (1) the user disabled the notifications, (2) the user skipped the notifications accepting in creation of the account.
\end{warningbox}
\subsubsection{Seeing an old version of the app}
\begin{warningbox}
\textbf{Problem:} User sees an old version of the app or changes are not reflected\\
\textbf{Solution:}
Unfourtunately, this is one of the limitations of PWAs. Because this is not actually installed as a real app (for the time being), it is treated as a normal website. Browsers cache (save a version of) the app to enhance performance and reduce loading times. This is especially true for Safari on iOS devices. Safari caches aggressively and does not always update the app when changes are made.
One can confirm the issue by opening the app in an incognito window. Long term solution for this issue includes either releasing the app to the App Store or using Versioning and Updating Service Worker on a newer version in JS.
The work around currently however is to simply clear the browser cache. As this problem is notable on iOS devices, the steps are shown below for iOS:
\textbf{iOS:} Delete the current application. Open Settings > Safari > Advanced > Website Data > Search for "wesal.online" or the hostname of the app > Swipe left and tap Delete. Reinstall the application.
\end{warningbox}
\subsection{Backend Optimization}
\begin{itemize}[leftmargin=*]
\item Use database indexing for frequently queried fields