Code Monkey home page Code Monkey logo

waylan_android's Introduction

Waylan

A dictionary that focuses on execution, ergonomics and experience concepts

Light banner

Get it on Google Play

Structure

Waylan is broken into modules. For a high level overview of each module, see the comments in settings.gradle.

Notes

For documentation, run ./gradlew dokka and view the javadoc under app/build/javadoc.

Build

This project depends on Firebase. If building from source, you'll need to set up a Firebase project, enable Firestore and Firebase Auth (anonymous & email) and download and include Firebase's google-servies.json.

This project also depends on the Merriam-Webster API. You'll need an API key which can be obtained from https://dictionaryapi.com. Create a file in the project's root folder called keys.properties with the line merriamWebster.key="<YOUR_KEY_HERE>".

waylan_android's People

Contributors

hunterstich avatar

Stargazers

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

Watchers

 avatar  avatar

waylan_android's Issues

Add :app database migration tests

After (or before!) breaking out a Merriam-Webster module, add database migration tests for moving from production to the new, post modularized database structure where :app has its own db for WordSet and :merriamwebster has its own db for MW data.

Related #17

Low-light smart shelf suggestions

Add ability to detect low-light scenarios and display a prompt to turn on dark theme in the smart shelf area (above the search input box)

Update colors system

  • Update color.xml to only contain palette colors.
  • Remove all *alpha colors from color.xml in favor fo res/color resources and optional theme alpha attribute combinations.
  • Update/remove as many non-standard Material color attributes from attrs.xml
  • Update light color scheme to be warmer

Migrate to MDC color theme

  • Remove all custom color attributes which can be replaced with mdc color attrs
  • Remove elevations specific colors in favor of ElevationOverlayProvider
  • Separate out palette (or remove) and set colors directly from palette values in themes.xml

Remove :about module

:about was a good module to experiment with but should no be removed in favor of either a larger :settings library module or placed back into :app.

Add module for custom user definitions

Add a dynamic feature module which allows users to add their own definitions, examples, synonyms, antonyms, etc. Custom inputs can be marked as private or public and can be added, edited, removed and reordered. These should be stored in Firestore.

Refactor smart suggestions into UseCases

It should be easy to maintain and add new smart suggestions (low-light, create an account, turn on orientation lock) without having to worry about the UI being able to consume these suggestions in a proper way (they won't show at the same time, they will be shown in a timely manner, they wont be shown too frequently/to close together, etc)

Move lineHeight behind textAppearances.

All TextView's in all layouts should be standard 's, letting Material auto inflate MaterialTextViews. lineHeight should be set in theme text appearances where possible.

Update search to show more available options

The current search sheet is confusing when the keyboard is open and a query is being typed. There is usually only one result visible (sometimes none on smaller screens).
The design of search should:

  • Allow easy, one-handed, fast input of a query
  • Allow easy, one-handed selection of a result
  • Show autocompleting results easily and understand how to "view more"

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.