Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 3 KB

README.md

File metadata and controls

33 lines (23 loc) · 3 KB

Exploding Words Data Processor

Build Status Codecov CodeFactor Grade contributions welcome

This mini-project is part of the Exploding Words application. It is solely responsible for preparing the data to be seeded to the backend database. The data is the list of English words together with the definition and example sentence.

Instead of processing the raw list of English words, this application also allows modification to the list. The allowed operations are the ADD operation and the DELETE operation. The app also provides the CHECK operation to verify the existence of a word in the list, which can ease the modification of the list. Finally, to get the desired data, the application calls the external Urban Dictionary API to get the definition and example; parse them together with the word into a JSON structured file (known as the DUMP operation). For more details on the design and implementation, check the wiki section of this repository.

The list of words, the definitions, and the example sentences belong to the external party. This application only consumes them for the completion of its purpose. See the credits section below for more details.

Demonstration

Adding a New Word to the Set

Removing a Word from the Set

Checking for a Word's Existence

Fetching a Word's Definition and Example

Credits

Trivia

  • This is a personal project for learning purpose
  • This project's primary goal is to increase my fluency in coding using the Kotlin programming language