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. Scribe-Server can be accessed via scribe-server.toolforge.org, with the SQLite data packs being available for download via scribe-server.toolforge.org/packs/sqlite.

[!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 to the team :) We'd suggest that you use the Element client and Element X for a mobile app.

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 the team isn't open to 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, [email protected]:....

• e.g. Cloning now becomes git clone [email protected]:<your-username>/Scribe-Server.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-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)

1. Navigate to the root directory of the project

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

   • Reference the config-example.yaml to get started

Important Note on PATH Configuration for Go Tools

After installing Go, it's highly recommended to add your Go binary directory ($(go env GOPATH)/bin) to your system's PATH. This ensures that tools installed via go install (like swag, oapi-codegen, etc.) are directly accessible from your terminal.

You can typically do this by adding the following line to your shell configuration file (e.g., ~/.bashrc, ~/.zshrc, or ~/.profile):

export PATH=$(go env GOPATH)/bin:$PATH

After adding this line, remember to apply the changes by sourcing the file (e.g., source ~/.bashrc) or by opening a new terminal session.

1. Install MariaDB locally via its installation guide.

   • Create a database using the database.name value from your config.yaml with the following commands (using Homebrew, for example):

   brew services start mariadb
   mariadb -u root  # you may need to sudo this command
   
   # To stop the server:
   brew services stop mariadb
   

   • You can now run the commands found in CREATE_SCRIBE_SERVER_DB.md to make the needed MariaDB database.

2. Start a local Scribe-Server:

   # Run the following target from the 'Makefile'.
   # Migrate SQLite files from Scribe-Data to MariaDB for use in Scribe-Server:
   make build
   make migrate
   # Start Scribe-Server on your local host:
   make run
   

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

3. To generate the documentation for Scribe-Server, please run the following:

   make docs
   

   Once the server is running (via make run or make dev), you can access the API documentation at:

   • Swagger UI: http://localhost:8080/swagger/index.html
     
   • Alternative docs: http://localhost:8080/docs/index.html

[!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 for all languages. You can check the currently available languages and data for Scribe applications on our website at scri.be/docs/server/available-data.

See scribe_data/wikidata/language_data_extraction for queries in the Scribe-Data project for currently supported languages and those that have substantial data on Wikidata. Also see the new keyboard label in the Issues for keyboards that are currently in progress or being discussed, and suggest a new keyboard if you don't see it being worked on already!

Featured By ⇧

Please see the blog posts page on our website for a list of articles on Scribe, and feel free to open a pull request to add one that you've written at scribe-org/scri.be!

Organizations

The following organizations have supported the development of Scribe projects through various programs. Thank you all! 💙

                   

                   

Powered By ⇧

Contributors

Many thanks to all the Scribe-Server contributors! 🚀

Code and Dependencies

The Scribe community would like to thank all the great software that made Scribe-Server's development possible.

Wikimedia Communities