Dad Joke API

Dad Joke API

1. Task requirements

   • prescribed criteria
     • Display API data aesthetically.
       • Ensure the app is multi-device friendly and adapts to various screen resolutions while maintaining functionality.
       • Have a good colour palette with nice contrasting throughout the webpage.
       • Implement size changing container for the joke size to make it more aesthetic.
     • Be efficient, modular and have accurate code
       • Ensure that the lowest number of lines are used for the python coding.
       • Have code be organized into separate modular functions and routes to ensure easy editing in code.
       • Make sure the code works as intended with no errors.
     • Have an algorithm to retrieve, process and display the dad jokes data from the API
       • Develop a function to make API calls, handle responses, and handle errors.
       • Allow parsing for API response from its raw formed to processed form.
       • Implement displaying joke when site is loaded and a route when clicking button to update the joke and display it.
     • Receive data in one format and programmatically transform it into another format for sharing/displaying
       • Write functions to parse the raw JSON data received from the API into programmatical JSON data.
       • Use jinja to display the joke variable onto the html page.
     • Make use of a publicly available API listed below (or an API of your choice approved by your teacher).
       • Pick an appropriate API for dad jokes which can be implemented into the python code.
       • Read the documentation to correctly add in the API request and to add error handling.
   • self determined criteria
     • Ensuring error handling relating to the API
       • Check what status codes it uses and implement the error handling based on the status code.
       • Add an error message to display on the webpage if failure status code is met/success status code is not met.
   • Constraints
     • Time
       • 10 weeks given
         • efficient time management needed
         • limited features added
     • Skill
       • low knowledge in field
       • not much experience
     • Money
       • hiring employees
       • paying for server expenses
   • Requirements
     • A python application which runs flask to make a web application which connects to HTML page and CSS.
     • Having the application fetch a random dad joke from an external API.
     • Showing errors if the API is down or if the joke is fetched incorrectly.
     • Converting the raw JSON from the API to Programmatical JSON to make it readable.
     • Having a working button which fetches another random dad joke and updates the website to display the new one.
     • Having aesthetic CSS on the website with a simple interface.

2. Impacts

   • personal
     • User is showed targeted advertisements which they would engage in and potentially get a product useful to them
     • Remote working for employees which increases productivity and provides convenience and encourages them to finish work to have more family time
     • Allows user to get a random dad joke with convenience
     • People who want a simple UI with efficient UX for dad jokes in a hurry are catered to and have a wider option to use including this application
   • social
     • Can lead to some people being irritated if users overuse dad jokes and might lead to hate towards the website
     • With the future improvement of adding built in sharing on other platforms, others can communicate more
     • A public community will be formed that uses this website and share around content and socialise
     • Encourages other organisations to include security features and being apart of a safe community
     • Users socialise as they tell their dad jokes to other people like family, friends, and peers
   • economic
     • Donations will be given to the website as it helps several users by providing exactly what they need and for improving website overtime
     • Jobs would be created, and developers would be paid for creating and maintaining the website
     • Monetisation can be made from adding targeted ads and users may find a product/service they needed from the ads
     • For future iterations and improvements, developers may need to be hired, creating more jobs
     • If data leaks occur, legal fees and fines would be pressed onto the website which also leads to bad reputation and partners will leave

3. User Problem

   • User Persona
     • Needs
       • To get a random joke
       • Have simple website with good UX
     • Frustrations
       • Being busy and having and very tight schedule
       • not having time to search through or find jokes

4. developer problems

   • resources
     • Internet
     • Teachers
     • Programs
     • AI
       • ChatGPT
   • coding environment
     • Coding languages
       • python
         • flask
         • jinja
       • html
       • css
     • development tools
       • thonny
       • notepad++
       • Microsoft VS code
     • Key algorithms
       • Get joke from API
       • Transform raw JSON to Programmatical
       • Displaying joke onto website
       • getting new random joke when button is pressed and update webpage
   • API components
     • Data exchange system
       • endpoint
       • client
       • server
       • resource
       • request
     • Data exchange application
       • UI and UX
       • Code & Algorithms
       • API's
       • Data
   • Data security processes
     • Encryption
       • Cryptology
         • Symmetric
           • DES
           • Triple DES
           • AES
           • RSA
         • Asymmetric
           • SSL/TLS
           • Crypto/blockchain
           • RDP
     • authentication
       • 2FA
         • Email
         • SMS
       • MFA
         • Biometrics
         • passkeys
         • Application
       • Password
     • hashing
       • MD5
       • SHA-256
       • RIPEMD-160
       • Whirlpool
   • Network protocols
     • IP Address
     • TCP (Transmission Control Protocol)
     • UDP (User Diagram Protocol)
     • HTTP/S (Hypertext Transfer Protocol/Secure)
     • FTP (File Transfer Protocol)
     • SMTP (Simple Mail Transfer Protocol)
     • DNS (Domain Name System)
     • IP (Internet Protocol)