/Scribe-Android

Android app with keyboards for language learners

Primary LanguageKotlinGNU General Public License v3.0GPL-3.0

Scribe Logo

platforms version issues language license coc weblate mastodon matrix

🌐 Language

Android app with keyboards for language learners

WIP port of Scribe-iOS: see Issues

Scribe-Android is a pack of Android keyboards for language learners. Features include translation (beta), verb conjugation and word annotation that give users the tools needed to communicate with confidence.

Scribe is fully open-source and does not collect usage data or ask for system access. Feature data is sourced from Wikidata and stored in-app, meaning Scribe is a highly responsive experience that does not require an internet connection.

Note

The contributing section has information for those interested, with the articles and presentations in featured by also being good resources for learning more about Scribe.

Also available on iOS, Desktop (planned) and for the data processes see Scribe-Data.

Check out Scribe's architecture diagrams for an overview of the organization including our applications, services and processes. It depicts the projects that Scribe is developing as well as the relationships between them and the external systems with which they interact.

Contents

Preview Images ⇧

Current WIP status


Android Preview

Contributing ⇧

Public Matrix Chat

Scribe uses Matrix for communications. You're more than welcome to join us in our public chat rooms to share ideas, ask questions or just say hi :)

Please see the contribution guidelines if you are interested in contributing to Scribe-Android. Work that is in progress or could be implemented is tracked in the issues and projects.

Note

Just because an issue is assigned on GitHub doesn't mean that the team isn't interested in your contribution! Feel free to write in the issues and we can potentially reassign it to you.

Those interested can further check the -next release- and -priority- labels in the issues for those that are most important, as well as those marked good first issue that are tailored for first time contributors. For those new to coding or our tech stack, we've collected links to helpful documentation pages in the contribution guidelines.

After your first few pull requests organization members would be happy to discuss granting you further rights as a contributor, with a maintainer role then being possible after continued interest in the project. Scribe seeks to be an inclusive and supportive organization. We'd love to have you on the team!

Ways to Help ⇧

Road Map ⇧

The Scribe road map can be followed in the organization's project board where we list the most important issues along with their priority, status and an indication of which sub projects they're included in (if applicable).

Note

Consider joining our bi-weekly developer syncs!

Designs ⇧

Public Figma Designs

The designs for Scribe are made using Figma. Those with interest in contributing can open a design issue to make suggestions! Design related issues are marked with the design label.

Data Edits ⇧

Note

Please see the Wikidata and Scribe Guide for an overview of Wikidata and how Scribe uses it.

Scribe does not accept direct edits to the grammar JSON files as they are sourced from Wikidata. Edits can be discussed and the Scribe-Data queries will be changed and ran before an update. If there is a problem with one of the files, then the fix should be made on Wikidata and not on Scribe. Feel free to let us know that edits have been made by opening a data issue or contacting us in the issues for Scribe-Data and we'll be happy to integrate them!

Environment Setup ⇧

Scribe-Android is developed using the Kotlin coding language. Those new to Kotlin or wanting to develop their skills are more than welcome to contribute! The first step on your Kotlin journey would be to read through the Kotlin documentation. The general steps to setting up a development environment are:

  1. Download Android Studio

  2. Fork the Scribe-Android repo, clone your fork, and configure the remotes:

Note

Consider using SSH

Alternatively to using HTTPS as in the instructions below, consider SSH to interact with GitHub from the terminal. SSH allows you to connect without a user-pass authentication flow.

To run git commands with SSH, remember then to substitute the HTTPS URL, https://github.com/..., with the SSH one, git@github.com:....

  • e.g. Cloning now becomes git clone git@github.com:<your-username>/Scribe-Android.git

GitHub also has their documentation on how to Generate a new SSH key 🔑

# Clone your fork of the repo into the current directory.
git clone https://github.com/<your-username>/Scribe-Android.git
# Navigate to the newly cloned directory.
cd Scribe-Android
# Assign the original repo to a remote called "upstream".
git remote add upstream https://github.com/scribe-org/Scribe-Android.git
  • Now, if you run git remote -v you should see two remote repositories named:
    • origin (forked repository)
    • upstream (Scribe-Android repository)

  1. Open the Scribe-Android directory in Android Studio

  2. In order to run Scribe on an emulator:

    • In the top bar find and select the "Device Manager" option
    • Create a device and select it once it's been made
    • Press the play button marked "Run App"
    • From here code edits that are made will be reflected in the app each time it is ran.

After activating your emulator, consider setting up pre-commit to fix common errors in the codebase before they're committed by running:

pip install --upgrade pip  # make sure that pip is at the latest version
pip install pre-commit
pre-commit install  # install pre-commit hooks
# pre-commit run --all-files  # lint and fix common problems in the codebase

Note

Feel free to contact the team in the Android room on Matrix if you're having problems getting your environment setup!

App Setup ⇧

Users access Scribe language keyboards through the following:

  • Open the app and press Enable Keyboard
    • Or: Settings -> System -> Languages & input -> On-screen keyboard -> Manage on-screen keyboards
  • Choose from the available Scribe language keyboards
  • When typing press 🌐 or the keyboard button to select keyboards

Keyboard Features ⇧

Scribe-Android is currently a work in progress and only has base keyboard functionality. The goal is to slowly add Scribe features before an initial release, and then iterate to match the functionality of Scribe-iOS.

Current features include:

• Base Functionality ⇧

The goal is for Scribe to have all the functionality of system keyboards. Currently the keyboards include:

  • Dynamic layouts for cross-device performance
  • Auto-capitalization following ., ? and !
  • Typing symbols and numbers followed by a space returns keyboard to letters
  • Hold-to-select characters for letters and symbols
  • Key pop up views for letters and symbols

Featured By ⇧

Articles and Presentations on Scribe

2024

2023

2022


Wikimedia Deutschland logo linking to an article on Scribe in the tech news blog.           Wikimedia Foundation logo linking to the MediaWiki new developers page.          

Google Summer of Code logo linking to its website.           Outreachy logo linking to its website.          

Powered By ⇧

Contributors

Many thanks to all the Scribe-Android contributors! 🚀

Code

List of referenced code

Wikimedia Communities


Wikidata logo           Wikipedia logo