Speaky

State

In progress

Technologies / Languages

  • HTML
  • CSS
  • Bootstrap
  • JavaScript
  • jQuery
  • PHP
  • mySQL
  • Docker

Description

Speaky is a Docker-based web application designed to simplify the management of multiple languages files. I observe privately and at work that syncing of the languages files are neglected. In retrospect, greater effort is required to maintain these neglected files. When multiple people work on a project at the same time, care must be taken to ensure that no key-value pair is forgotten when synchronizing. Speaky is designed to keep the language file valid and draw attention to missing keys. It should also offer suggestions for translations and match the new words with terminology data. This ensures that the texts are also written by different people in the same style.

The following workflow shall be supported:

  1. Developer creates a new key-value pair through the IDE extension
  2. Author receives a notification about the new key-value pair
  3. Author corrects the key
  4. Developers will be informed via the IDE extension that the key has been altered and asked if the code should be adjusted automatically.

The project is relatively in the beginning. Currently it shows only mockups for the functionalities that are not yet implemented.

Key features

  • User management
    • LDAP support
    • Different user classes with different permissions
      • Author
      • Developer
      • Intern/Student
    • User activity log
    • Direct contact via email-button
  • Settings
    • Integrate the language files of several projects via the Dockerfile
    • Defining your own file syntax
    • Multiple file type support
      • .properties
      • .ini
      • .xml
    • Definition of allowed key patterns
    • Import and export of terminology data
  • Dashboard
    • Statistics on the completeness of the individual language files
    • Statistics on the number of key-value pairs over time
    • List of recently added key-value pairs
    • List of violations of the key pattern
  • Languages files management
    • Add key-value pair
    • Edit and search by key-value pair
    • Check key-value submissions submitted by the developer
    • Add missing pairs with suggestions from google translators
  • Terminology management
    • Add favorite words with synonyms
    • Edit and search the entries
  • IDE extension for directly incorporating new key into the code

Screenshots

No images found.

See also