Giter Site home page Giter Site logo

103sbavert / jada Goto Github PK

View Code? Open in Web Editor NEW
20.0 2.0 0.0 4.21 MB

JADA - Just Another Dictionary App

License: MIT License

Kotlin 100.00%
android mvvm mvvm-architecture retrofit2 navigation-architecture-component android-application dictionary multilanguage material-ui material-design

jada's Introduction

JADA (Just Another Dictionary App)

(Licensed under the MIT License)

drawing

Update as of Monday, 25th of July, 2022

JADA is no longer work under progress or being maintained. You are free to send fork, send pull requests to, clone or maintain this project. The reason for this termination is the change in Oxford's pricing model (and the end of the Protoype plan which allowed JADA 1000 calls per month) and the lifting of support for other languages by the API developed by MeetDeveloper (@meetDeveloper).


Keep in mind that JADA is not a translator app. Nothing does a better job of being a translator app than Google Translate. JADA provides you definitions of a word in the same language as the one the word is from.

Collaborators

  • Patricia B.: The designer of the app's new UI overhaul. Most of the design was designed by her, I am highly thankful to her for helping me out.

Download

Currently the app is only available on Github releases due to some compilcated personal reasons. You can download the app from Github releases here.. JADA no longer works. You can still download the apk from Github releases if you need it for other purposes.

Multi-language Support

This dictionary supports multiple language as the API I am using does too. The languages supported are the following

  • English US
  • English UK
  • Hindi
  • French
  • Gujarati
  • Latvian
  • Romanian
  • Tamil
  • Swahili
  • Spanish

Versioning

The app uses a special blend of Semantic Versioning and some conventions decided by me to follow for this app since the guidelines for MAJOR in MAJOR.MINOR.PATCH are not compatible with Android Apps. Everything is essentially the same except for a few key differences with MAJOR:

  • MAJOR would be incremented if MINOR reaches 9
  • It may also be incremented whenever the app stops supporting an old API level
  • It may also be incremented upon any change that I consider major.

What's special

The dictionary was made with clean architecture practices and ease of reading of the code in mind.

It uses Kotlin entirely and it uses Navigation Components and parts of the MVVM architecture pattern.

It uses Retrofit2 to access a webserver that uses the API mentioned above to retrieve information about the word entered by the user in the search bar and to show the results it uses a recycler view. It also uses Material Components throughout the app wherever possible.

This app can be used by absolute beginners as a way to learn some basic things like using ViewModels or LiveData or Material Components.

I have commented every piece of code that I believed was not part of common things you do in Android Development. All the logic and operations done by me that are not common practices and unique to this particular app were explained with comments.

There can be found many parts that could use some improvement since I by no means claim to be a perfectly skilled or experienced developer, in fact, relative to so many awesome developers out there, I am very much new. I would like to get suggestions to improve my code or app from other experiened developers.

jada's People

Contributors

103sbavert avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

jada's Issues

Language Request

Hello, Can you plzz add the Urdu language and Additionally I really loved your project and want to contribute to it.
I can help you with the graphic assets bcoz I am a graphic designer and I you want your app to be published on the play store for free I can publish this app for no cost, trust me here is the link to my developer page: https://play.google.com/store/apps/dev?id=5781774584219069382

Question about support for other dictionaries

Hello,

I just installed your application and quickly tested it. Seems to be pretty cool!

I admit I didn't investigate thoroughly by myself, but I have some questions. First, do you plan to implement support for other dictionaries? For instance wiktionary (supposing they have an API)? And could you give me some clue how such support could be added to your application (for a non-mobile dev)?

Thank you!

Br Portuguese doesn't work

Installed from IzzyOnDroid, v. 4.4.0 All works flawlessly, except for Br Portuguese: when selected no definition is found (tried with several common protuguese words) and moreover the option for changing the language disappears (I was forced to reinstall). Thank you!

Need help

I would love to try building this project with a personal api key if something like that is possible. Something similar happened to reddit some time ago and now you can build your 3rd party app with custom api key so I would appreciate if you can put instructions to build your project from source and also add an option to use a personal api key if that's possible.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.