Dad Joke API

Dad Joke API

1. Task requirements

   • Prescribed Criteria
     • The web application must use a minimum of one external data source.
       • Synchronizes the data changes from the SAP database.
       • Using at least one of the 3 SAP databases.
       • Web application connects to an external SAP database.
     • The web application must display the data from a minimum of one external data source.
       • The web application connects to the SAP database.
       • Display updates regularly to synchronize data change in SAP databases.
       • Displays the data onto the web application via Jinja.
     • The web application must incorporate the use of Usability Principles.
       • Incorporate all Usability Principles which are utility, safety, effectiveness, learnability, and accessibility,
       • Have clear use of all usability principles on the web application.
       • Have accessibility options present on all webpages.
   • Self Determined Criteria
     • Have functional aesthetic CSS.
       • Design visually pleasing webpages by the use of colour and contrast.
       • Have a consistent design throughout the website using a specific colour palette. with seemly data retrieval
       • Make sure all css elements direct to the right function.
   • Existing Solutions
     • SuperAuto.pet
       • Pros
         • Has a search by name
         • Big clear images and icons
         • Has detailed information in each pets/foods page
       • Cons
         • Not many filter options
         • No accessibility options
         • Shows old icons and old icon sources
     • Superautopets.wiki.gg
       • Pros
         • Has a search for every item in the game
         • Clear images and icons
         • Has detailed information in each pets/foods page
         • Main page of foods shows the effect information in more details
       • Cons
         • Not many filter options
         • No accessibility options
         • The detailed page of any food has lots of details to process with small font
   • Constraints & limitaitons
     • Time
       • 2 months provided
         • Efficient time usage needed
     • Skill
       • By a high school student
         • Not much experience
         • Limited knowledge

2. User problem

   • User persona
     • Saun Thornberry
       • Needs
         • Have an easy to use platform that shows SAP Information
         • Big enough font for reading on mobile
         • Aesthetically pleasing website
         • Have Toys or Food data
       • Frustrations
         • When website is not good looking
         • When font is too small on a website

3. Impacts

   • Personal
     • People get to know what foods there are and what they do helping with memory and improvement in the game.
     • They can have an easier time to remember statistics for their games to help them play more competitively.
   • social
     • People can use this while they are versing someone to have a knowledge advantage and have higher chance in winning against others.
     • People can share their newly acquired knowledge by interacting with others or sharing link to the website to spread knowledge.
   • economic
     • People can earn money by playing in competitions due to having a better knowledge.
     • Developers can be hired to manage the website which creates jobs for them.
     • It increases SAP player base where users could buy packs which creates spending for the user and earning for SAP.

4. Developer problems

   • User interface
     • Usability principles
       • Usibility
         • The utility offers the website's functions according to the user's needs.
           • Updating and displaying data
       • learnability
         • Learnability is how easy it is for any user from anywhere to work and learn with the website
           • Universal icons
       • effectiveness
         • Effectiveness enables users to utilize the website, achieving their intended actions through the system
           • Does what user intends
       • accessibility
         • Accessibility is the ability for the site to be used by all sorts of people
           • dark mode
       • safety
         • Safety ensures that users can rectify errors if they make any while using the system
           • dark mode is toggleable
     • User interface components
       • Buttons
         • Dark mode button to allow user to enter and exit dark mode
       • Images
         • So users can clearly identify the food and find a specific food faster
       • Links
         • To be able to share links of the website
       • Table elements
         • When hovered the table is highlighted to provide better sight of cursor
   • coding environment
     • key algorithms
       • Display function
     • development tools
       • Thonny
       • Figma
     • Coding languages
       • HTML
       • CSS
       • Python
         • Jinja
         • Flask
       • SQLite
   • data
     • data storage and retrieval
       • SQLite database
         • Create table
         • Could use MongoDB
       • Functions
         • Display & search
     • dataset options
       • Pets
         • Pros
           • Is part of same pack as foods
           • Key part of the game
           • Very useful to new players
           • Data is normalised
         • Cons
           • Not needed by Saun Thornberry
           • Only of one pack
           • Old images, old source, and only from one pack
       • Foods
         • Pros
           • Meets user persona need
           • Integral part of the game
           • Users find harder to remember than pets so they want food information
           • Data is normalised
         • Cons
           • Only foods from one pack
           • Old images, old source, and only from one pack
       • Toys
         • Pros
           • Meets user persona need
           • Supplies to a small demanding niche
         • Cons
           • Only in puppy pack
           • Data is very messy
           • Lots of cleaning and normalising to do
           • Old images and old source
       • All mixed
         • Cons
           • Toys are a part of ferret pack and pets and foods in dataset are only for original pack
           • Foods and toys together serve no purpose to each other
           • Foods and Animals can be together but user persona needs food or toys
       • Chosen option based on weighting pros and cons of options
         • Only Foods dataset
           • meets user persona
           • complex to add toys due to time constraint
           • user persona does not need pets dataset
           • No rational schema due to one dataset
     • required data
       • Data type
         • Integer
         • Text
         • Varchar
       • Constraints
         • Limited datasets
         • All not null
         • Old data in datasets
   • Resources
     • Internet
     • Teachers
     • Programs