mingiryu/visionary

A visual dictionary

visionary's Issues

Add image search API

Related ticket: #1

Lexica, an image search API, https://lexica.art/docs

Add view model for handling internal state

Related ticket: #1

List of items/issues remaining

• aesthetic: Font size/color, Recyclerview background color, Single Image view, etc
• Remove search bar from action bar
• Going back using Android's feature: When you swipe right to go to previous screen (from images back to search for word), the first time it takes you to a blank screen. If you try another time it'll take you to the main screen. Can this be fixed?
• Back button: Going from Image activity back to main activity resets the definitions and recyclerview. Is there an easy fix?
• Add more than just definition [part of speech, phonetics, etc.]
• Fix height of definition row: Each definition row in the recylcerview has a large heigh. This needs to be fixed to wrap content instead.
• Recycler view works, but I'm initializing it every time we click search. Can we initialize it once and update data? It's just a better coding practice but not a huge deal
• Finally if there is time, maybe photos keep getting added as we go down.

Add layout for single image view and image caption text

Related ticket: #1

More detailed definition card rows

Related ticket: #15

The definition row only contains the simple definition, but we can leverage other fields such as part of speech, example, synonym, etc.

There's a possible challenge dealing with the nested array format of the data.

Add dictionary API

Related ticket: #1

Free Dictionary API, https://dictionaryapi.dev/

Add splash screens

Related ticket: #1

Infinite scroll for images

Related ticket: #15

Not sure how feasible this is, but worth looking into

What if the word is not in the API?

If the word does not exist, the format of the JSON changes.
At least we have to catch the error and display a message.

Project Proposal

Visionary, a visual dictionary

Contributors

• Mingi Ryu
• Faraz Heravi

App

We are building a visual dictionary where you could input any English word while getting back definitions, phonetics, and a gallery of images related to the definition of the word back. The main purpose of this app is to help English learners with their vocabulary with the help of visualization.

Subsystems

The app will contain 2 APIs, a dictionary API which provides the definitions, phonetics, synonyms, and etc, and an image search API which provides the related Images.
The app will contain an editable text field to search for words. This search will redirect users to another activity with the word definition and a gallery recycler view containing the images.
There will also be a loading screen and a single Image view in order to enlarge an image and display a prompt describing the image.

Challenges

Here is a few challenges that we will need to overcome:

• Handling two different APIs: Each API will contain a different GET schema which needs to be built
• Displaying an image gallery from the API: Displaying images in Android has proven to be a major challenge, especially when it's requested from the web in different sizes. We will need to do this in a recycler view.
• Handling non-existent words: The dictionary might not be up to date with very new English words, so we will need to find an external way to handle user requesting words that are not in the API.
• Use of fragments/activities: There will be a lot of redirection in our app compared to the homeworks done in class. Successful activity transitions become an important challenge of this project. An example of this is mapping images into text description. While the API provides a text description, we need to pass around this information from the gallery to the single image view.

Schedule

Week 1: Set up project, loading screen, search bar view
Week 2: Set up dictionary API call and previewing definitions
Week 3: Set up Image search API call and previewing images
Week 4: Set up gallery recycler view and display images alongside definitions
Week 5: Set up single image view with detailed components and prompt
Week 6: Debug UI and components, thoroughly test the app, wrap up

List of APIs used

• Lexica, an image search API, https://lexica.art/docs
• Free Dictionary API, https://dictionaryapi.dev/

Material Specification

• API Request
• Gallery
• Recycler View
• Optimization
• Scrollable view, search view, single image view
• Intents and view models
• Activities/Fragments

Functional Specifications

• When the app is opened, the user will see a loading screen.
• User will then see a search bar. User can input any word into the field.
• If the word exists, user will see the definitions and phonetics of the word at the top, and the gallery of images at the bottom half of the screen. If the word does not exist, the images will still appear at the bottom, but the top of the screen will redirect user to external resources.
• User can click on any image to see another view containing an enlarged image with a prompt explaining the image.

Other apps and inspirations

Two apps come into mind for inspiration. One is StarryAi, an app that generates art from text description. A similar app, Dawn AI, is another app which generates art from words. We were able to find Lexica, which is an image search API but in art format. The design is inspired somewhat from any web search for images. With the help of the dictionary API we are able to turn this image feature into an English learner's tool.

Clickable words on the single image view prompt

A nice feature if we can enable users to look up definitions for new words they see on the prompt

Add layout for home page with search bar and about section

Related ticket: #1

Search on edit text enter

Search only works on button click, it should support when user presses "enter" on the keyboard

Add layout for recycler view with word definition and scrollable image view

Related ticket: #1

New activity for dictionary definitions

I think it'd be cleaner if we had definitions on another activity UI