Skip to content

IU-MAP/avzag

 
 

Repository files navigation

Avzag Dictionary

deployment status code quality test

This repo is a fork of Avzag project for IU-S21-MAP course. During the course the team of @qazybi, @alkaitagi, @annwhoorma will develop the new Dictionary module for the application. The web site is written using VueJS framework in TypeScript language.

The goal of the project is to develop a cross-lingual dictionary with efficient search and rich data representation. The system should provide capability for searching offline, and in various grammatical forms and usage samples for the dictionary entries.

Our backlog can be found in the "Projects" -> "Dictionary" section.

Our final report can be found here.

User documentation (or how to use it)

Whenever you need to get a quick translation of a word and see some examples of how to use it, you can go to the website, choose a set of languages you need and then you'll be transferred to the dictionary. It will take a few seconds to load the words according to the languages you chose. Then you can type in a word you need to get translation of. Within a second you'll see possible matches for the language you chose. You can also see some use cases and forms for those words. Yup, that simple :)

If you are an editor and would like to bring more words to the dictionary, there is an interface for you. At the main page with the map, you can click on the "info" sign at the top left corner and choose "Editor". Then you'll need to choose what exactly you want to which part of the database you want to add to: phonology, converter, phrasebook (or even phrasebook corpus), or dictionary. Then you just follow the interface and fill the necessary fields.

In case you are lost and/or noticed some inconsistency, you click on the "info" sign, that is in the top left corner, and choose "Channel". That will take you straight to the telegram chanell with other people who are passionate about dagestani languages.

Technical documentation

Unfortunately, we didn't deploy our technical documentation. Instead, we store it in ./docs folder. You can clone the project, and do the following commands:

~/.../Avzag >>> cd docs
~/.../Avzag/docs >>> python -m http.server

Most probably it will be served at localhost:8000 and all you need to do is to go there.

Project setup

After donwloading the repo for the first time yarn install. To run the app locally yarn serve.

Sprints

You can find sprints-related information (including burndown chart) in this discussion.

You can find our backlog and sprints board here. Note that we have one board for all sprints, each task has a tag with a sprint number.

About

Languages, sounds, and scripts.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 49.4%
  • Vue 25.0%
  • TypeScript 16.7%
  • SCSS 5.1%
  • HTML 3.8%