Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.

First-Peoples-Cultural-Council/mothertongues-UI

 
 

Repository files navigation

Mother Tongues Dictionaries UI (MTD-UI)

This repo is under construction and could change drastically in the coming months with breaking changes.

license standard-readme compliant

MTD is the second of two open-source tools that allow language communities and developers to quickly and inexpensively make their dictionary data digitally accessible. MTD-UI is a tool that visualizes dictionary data that is prepared with MTD.

Please visit the website or docs for more information.

Table of Contents

Background

This is a basic Ionic app for displaying Mother Tongues Dictionaries data. Other frontends are in development.

Note - Just because you can make an online dictionary does not mean you should. Before making a dictionary, you must have clear consent from the language community in order to publish a dictionary. For some background on why this is important, please read sections 1 and 2.1 here

Usage

In order to use MTD-UI you must have a generated language configuration file and generated dictionary data from MTD. Then, either fork or clone this repo and put those files in either the www/assets/js/ folder right away or in src/assets/js/ in order to build the app from source.

Audio Verification

If you wish to verify the audio used for this app, run:

npm run verify:data > audio-fix.tmp

The results will be in the audio-fix.tmp file. This operation may take some time depending on the size of the dictionary.

Note This verification should have already happened during the export to MotherTongues format, and before creating the dictionary export. Only use this in rare cases (for example when community reports broken$

You can then act on your verification output using:

npm run verify:data:fix

This will attempt to download missing files from FirstVoices, then upload them to S3. You must have AWS CLI configured locally for this to work. You can also attempt these fixes manually.

Contributing

PRs accepted. If you would like to create more MTD-UIs those are also accepted.

Acknowledgements

MTD-UI has had significant help from a huge number of people including but not limited to Patrick Littell, Mark Turin, & Lisa Matthewson.

As well as institutional support from the First Peoples' Cultural Council and SSHRC Insight Grant 435-2016-1694, ‘Enhancing Lexical Resources for BC First Nations Languages’.

License

MPL-2.0 © Aidan Pine.

About

A Mother Tongues Dictionary front end for visualizing your MTD dictionary data

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 89.4%
  • CSS 9.3%
  • Other 1.3%