Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 4.7 KB

README.md

File metadata and controls

108 lines (73 loc) · 4.7 KB
Raw

Data files for movapp.cz applications

cesko-digital/movapp / cesko-digital/movapp-apple

Source is under MIT license. Texts, images and audio files are under CC BY-NC 4.0 license.

Why?

This repository is for opening our data files to #opensource community. Our applications copy the data files as needed.

Our data is created and updated in Airtable (Phrases and Categories, login required).

Languages

We are providing translations from Ukraine to given languages

Language Dictionary Alphabet
Ukraine (uk) ✅ ✅
Czech (cs) ✅ ✅
Slovak (sk) ✅ ✅
Polish (pl) ✅ ✅
English (en) 🆘 🆘

What to add new language? Contact us at [email protected]

Tools

We have developed some tools to help us automate boring stuff using nodejs scripts written in Typescript.

Development

At first install all dependencies.

npm install
  • We need to convert out Typescript code to nodejs Javascript using ts-node
    • npm run build Build once
    • npm run watch Build on changes
  • We need to ensure same style of code using npm run lint

AirTable to JSON data structure

API keys

  • You can set environment variables by creating a .env file according to .env.example.
  • You can also use run configurations (PHPStorm or any other IDE). Set the environment in GUI and do not store the file to the repository.
  • Alternatively, you can set environment variables using the command line:
export AIRTABLE_API_KEY=YOUR_SECRET_API_KEY
export AZURE_SUBSCRIPTION_KEY=KEY
export AZURE_REGION=REGION
#export DEBUG=true

Running the script

For showing debug logs use DEBUG=true environment (in file or by passing to cli)

npm run build:dictionary
npm run build:alphabet

Using Github actions

Build from AirTable

  1. Go to Actions / Build from AirTable
  2. Pres Run workflow on the right side above "workflow runs table" button and select main branch and Run workflow

Using the data

Release strategy of team.json

  • If you change the file structure (breaking changes), you must release a new version of team.json,example: team.vX.json.
  • If you added new property in team.json you have to adjust team.schema.json.
  • If the changes contains only new additions (new name, new section) then we do not need to update the clients so no need of new version

Kid's section

The movapp website and apps have a separate vocabulary section for children (and a memory game). Phrases for these sections are stored the same way as any other phrase category. Use the recSHyEn6N0hAqUBp category id to retrieve the Kid's section phrases.

Stories data for iOS and Android

The idea is to manage stories in central repository that will be automatically distributed to client apps without any dev cost (just reviewing the PR).

Adding new story

  1. Create new folder in data/stories folder. The name of the folder is a URL slug of the story.
    1. In this folder add all story MP3s named by a language code: uk.mp3, cs.mp3, pl.mp3 and more.
    2. Generate the metadata.json file, you can use stories_transformer.rb for now, just open command line and type ruby stories_transformer.rb path_to_web_file and move the file to this folder and rename it to metadata.json
  2. Add your story to the data/stories/metadata.json
  3. Add new folder into data/images/apple or data/images/android folder the name is the same as the URL slug of the story.
    1. For apple use @1, @2, and @3 images (you can use resizer)
    2. For Android you have to use webp file.