Backend service for Scribe data downloads

Scribe-Server is a backend service that provides the API by which data is available for download within Scribe apps. The goal is to create a Scribe-Data based regularly updating dataset that can signal new data availability as well as allow for language pack downloads.

[!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.

Scribe apps are available on iOS, Android (planned) and Desktop (planned). For the data formatting 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

• Contributing
• Environment Setup
• Supported Languages
• Featured By

Contributing ⇧

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-Server. 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 ⇧

• Reporting bugs as they're found 🐞
• Working on new features ✨
• Localization for the app and Google Play 🌐
• Documentation for onboarding and project cohesion 📝
• Adding language data to Scribe-Data via Wikidata! 🗃️

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!

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-Server is developed using the Go programming language. Those new to Go or wanting to develop their skills are more than welcome to contribute! The first step on your Go journey would be to read through the Go documentation, with the Effective Go page in particular having great insights into the language's good practices and standards. The general steps to setting up a development environment are:

1. Download and install Go

2. Fork the Scribe-Server 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:/Scribe-Server.git` GitHub also has their documentation on how to [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) 🔑

# Clone your fork of the repo into the current directory.
git clone https://github.com/<your-username>/Scribe-Server.git
# Navigate to the newly cloned directory.
cd Scribe-Server
# Assign the original repo to a remote called "upstream".
git remote add upstream https://github.com/scribe-org/Scribe-Server.git

• Now, if you run git remote -v you should see two remote repositories named:
  • origin (forked repository)
  • upstream (Scribe-Server repository)

3. Navigate to the root directory of the project

4. Create a config.yaml file with the configuration needed for the project

   • Reference the config-example.yaml to get started

5. Start a local Scribe-Server:

   # Run the following target from the 'Makefile'.
   make run

   • NOTE: This make target simply runs go run . on the project
   • Scribe-Server should now be running locally!

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

Supported Languages ⇧

Scribe's goal is functional, feature-rich keyboards and interfaces for all languages. Check the Scribe-Data extract_transform directory for queries for currently supported languages and those that have substantial data on Wikidata.

The following table shows the supported languages and the amount of data available for each on Wikidata and via Unicode CLDR for emojis:

* Given the current beta status where words are machine translated.

† Only for languages for which preposition annotation is needed.

Featured By ⇧

                   

                   

Powered By ⇧

Contributors

Many thanks to all the Scribe-Server contributors! 🚀

Wikimedia Communities