Waylan

A dictionary that focuses on execution, ergonomics and experience concepts

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>".