Technical Proposal IA3

Technical Proposal IA3

1. Resources/Coding Environment

   • Development Tools
     • IDE. eg. VS code, Thonny
     • Front-end
       • HTML, JS, Django
     • Back-end
       • Language: python
       • Flask
     • Data source
       • Marvel API
   • Troubleshooting
     • Stack Overflow
     • Quora
   • Key Algorithms
     • Filter JSON data
       • Parse needed data from response
         • Use loop
         • Append each filtered result to a list
       • Convert JSON response to python dictionary object
       • Saved Filtered response as list of dictionaries
         • Keys
           • Character Name
           • Comic Events
           • Comic Series
           • Description
     • Make API Call
       • Format search query based on user input
       • Receive JSON response
       • Use Python Requests Module
     • Display Data
       • Use HTML and DJANGO
       • Style with CSS
   • Data Storage/Retrieval
     • Python Requests module
       • Query Parameters
       • URL Endpoint
     • Marvel API

2. Data Sources

   • Marvel API
     • Pros
       • Allows for data to be updated over time
       • Contains extensive Marvel data
     • Cons
       • Data about search results limited to 20
       • Limit is only 100 for search results
       • Only contains Marvel Data
       • Missing data entries
     • Features
       • Description
         • String
       • Comic Series
         • String
       • Character Name
         • String
       • Comic Events
         • String
       • Image link
         • Link is string
         • Links to JPG

3. User Interface

   • Useability Principles
     • Accessibility
       • Dark mode/light mode
     • Effectiveness
       • Use drop down boxes
     • Safety
       • Ask for confirmation before finalising actions
     • Utility
       • Show user with list of search results
     • Learnability
       • Incorporate intuitive
   • Features from Existing Solutions
     • Descriptions of characters
     • Dark mode
     • Streamlined presentation of data for user
       • Results are shown in a table
       • Search inputs are well placed
     • Light mode
     • Marvel API is used

4. User Persona

   • Max Power
     • Positives
       • Simple and uncluttered UI
       • Ability to filter results alphabetically
     • Negatives
       • Not knowing all the detailed stats of Marvel Superheroes
       • Having difficulty in conversations with customers
   • Jennifer Taylor
     • Positives
       • Ability to search for characters
       • Able to check out character details
       • Works on phone
     • Negatives
       • I really dislike Wikis
       • Unreadable solutions

5. Components of Data Exchange Systems

   • Client
     • Party that receives a service.
     • Example: Web browsers.
   • Server
     • Centralised computing system that provides a service.
     • Example: A common web server is the Apache HTTP server.
   • Request
     • Used by client to retrieve data.
     • Example: API attempting to retrieve a JSON file.
   • Resource
     • Anything accessible by a computer system
     • Example: A printer connected to a network.
   • Endpoint
     • Any system performing two-way communication.
     • Example: Include devices such as phones.
   • REST
     • An architectural style standardising system communicating.

6. Data Security Processes

   • Encryption
     • Transforms plaintext into ciphertext.
     • Types
       • Symmetric
       • Triple Data Encryption Standard
       • Asymmetric
   • Authentications
     • Process of verifying a user.
     • Example: Passwords Authentication
   • Hashing
     • Includes passing data to be encrypted through some one-way formula
     • Example: A user saves password to a database.

7. Existing Data Exchange Methods

   • JSON
     • GraphQL
       • Responds with JSON object
       • Aggregates data from multiple sources
     • Lightweight
     • Human readable
     • Key value pairs
     • Arrays/nested objects
     • Compact
   • XML
     • SOAP
       • Uses XML
       • Relies on protocols such as HTML
       • Supports remote procedure calls
     • Not Compact
     • Markup language
     • Used for more complex data
   • SQL
     • Commands
       • SELECT
       • INSERT
       • UPDATE
     • Constraints
       • FOREIGN KEY
       • PRIMARY KEY
       • NOT NULL
     • Datatypes
       • Varchar
       • Float
     • storing, retrieving, and managing data
     • relational databases