Dad Joke API

Dad Joke API

1. Impacts

   • Social
     • Family
       • Sharing of dad jokes between father and son
     • Community
       • Sharing of dad jokes between fathers
       • General sharing of jokes
   • Economic
     • Low economic impact
       • Only requires simple coding
       • Requires simply one page
       • Data security is not much of an issue as no personal data is being stored
   • Personal
     • Fathers
       • Knowledge of a wide range of dad jokes
       • Keeping family tradition alive
     • Children
       • Incorporates humour into life
       • Numerous developmental(positive) effects

2. Developer Problem

   • User Interface
     • User interface components
       • A simple element containing the dad joke
       • Top bar for website name
       • Buttons
     • Features
       • Text
       • Pictures
       • A button
     • Usability principles
       • Accessibility
       • Effectiveness
       • Safety
       • Utility
       • Learnability
   • Coding Environment
     • Development Tools
       • Visual Studio Code
       • Thonny
         • Flask
         • Requests
     • Key algorithms
       • Retrieve data
         • Back end processes
           • API calls
           • Establishing API connection
           • Able to retrieve any joke
       • Display Data
         • Front end process
           • HTML page to display joke
           • Organising data on the webpage
           • Displaying correct information with proper presentability
   • Data
     • Data storage and retrieval
       • API
         • A public API
         • All maintained on its own
         • API calls
     • Data source options
       • A dad joke API
         • Icanhazdadjoke
     • Required data
       • Raw JSON data
       • programmatically transformed JSON data

3. Task requirements

   • Constraints and Limitations
     • Coding Environment
       • Python
         • Flask Application
           • Data display
           • Good compatibility with Python
       • CSS
         • Stylistic Components
       • HTML
         • Jinja
           • Displaying data on the webpage aesthetically
     • Time
       • Back-end process coding
         • Simple coding component for backend
         • Minimal time needed
         • Data retrieved must be correct
       • Front-end process coding
         • Minimal time needed
         • Only a simple user interface is required
         • Must be a consistent website design
     • Skills
       • proficiency in HTML
         • Must display proper use of HTML elements
         • Must display consistent and proper data
       • Proficiency in CSS
         • Needs to make the website visually aesthetic
       • proficiency in Python
         • Must set processes to retrieve and display data correctly from API
         • Must have error handling processes
         • Incorporate functions to make coding easier and more understandable
   • Existing solutions
     • dadjokegenerator.com
       • Pros
         • Stylistic User interface
         • High interactivity
         • More 'fun' display of jokes
         • Correct and proper jokes
       • Cons
         • Website is very simplistic
         • Strange colour scheme
   • Criteria
     • Prescribed
       • The application must display the API data aesthetically
         • The application must follow the usability principles
         • The application must follow the principles and elements of visual communication
       • The application must be efficient, modular and have accurate code
         • The code must be formed from the least amount of code necessary
         • The code must be fully functional and meet task requirements
         • The code must use designated functions to make the code less redundant
       • The application must make use of a publicly available API
         • The correct data must be displayed coherently and accurately
         • The code must retrieve the data from the API
       • The application must programmatically transform data from one format to another for displaying
         • The raw data must be JSON
         • The raw JSON data must be programmatically transformed
         • Correct data must still be displayed
       • Application must have an algorithm to retrieve, process and display the dad jokes data from the API
         • Application must call the API to get a response
         • Application must have error handling
         • Data transferred must be secure
     • Self Determined