granito-source / segovia

Segovia

An application to facilitate learning a foreign language.

Building application

gradle clean build

Running application

java -Dloader.path=~/segovia -jar app/build/libs/segovia-app-1.0.0-SNAPSHOT.jar

Argument -Dloader.path=~/segovia is optional at this time. This directory is to contain the application's configuration files and any libraries to override the behavior of the classes in the executable JAR. It is a comma-separated list of directories (containing file resources and/or nested archives in *.jar or *.zip or archives) or archives to append to the classpath. BOOT-INF/classes,BOOT-INF/lib in the application archive are always used.

segovia's Issues

Access application via web UI

As a Student I want to be able to access the application via web interface, so that I could study using any modern web browser.

Acceptance criteria

Confirm that:

• the application JAR can be started successfully from the command line;
• the application keeps running until it receives SIGINT;
• the application listens on port 8080;
• accessing http://localhost:8080/ shows a web page with Segovia title and Segovia headline.

Tasks

• Create Gradle project.
• Setup CI integration.
• Create Angular placeholder (ui module).
• Create web application (web module).
• Create application executable JAR (app module) with Concordion integration tests.

Show sentence

As a Student I want to see one sentence in the foreign language to work on, so that I could learn the language by answering challenges about the sentence.

Acceptance criteria

Confirm that:

• when a user accesses /study page, it shows the sentence stored in the backend rendered on the page.

Assumptions

• Until we have various languages and students' profiles showing what language they know and what they study, the native language is English and the foreign language is Spanish. We can start with this pair: Mala Hierba and Weeds.
• This story deals with just one sentence, but we want this to be a tracer bullet story, showing that SPA can talk to the backend API. How the backend persists the sentence is not important at this time.
• Persistence is not in scope now: any fake repository will do.

Tasks

• Update software specifications.
• Create the root web entry point.
• Create a web entry point for sentences: list, fetch.
• Create a use case to list available sentences (just one for now).
• Create a use case to fetch a sentence by its ID.
• Create UI component to render a sentence from API.
• Create UI service to get get sentences.
• Create UI service to get the API root.

Show word translation

As a Student I want to be able to see on demand translations for individual words in the sentence, so that I could parse apart the meaning of the sentence and compose new sentences from the words I know.

Acceptance criteria

Confirm that:

• words in the displayed sentence are clickable if a translation exists for them (they may also be clickable due to the whole sentence having the translation, see story #4);
• when clicked, a translation of the word is shown, possibly together with the translation of the whole sentence in the same pop-up;
• the translation uses lemmas, e.g. if the word is hicieron, the lemma is hacer and this is what we translate;
• the pop up also shows lemma for completeness.

See also

• Story #4.

Show expression translation

As a Student I want to be able to see on demand a translation of an expression when its words cannot be translated 1:1 to my native language, so that I could understand idiomatic expressions in the foreign language.

Acceptance criteria

Confirm that:

• if a certain group of words has a translation as an expression, it is also displayed together with the word translation when any of the words in the group is clicked;
• a group can consist of non sequential words, e.g. if the sentence is Check it out!, words check and out is an expression and has to translated as such;
• lemma-like form is used for the expression translation, e.g. if the sentence is Lo han pasado olimpicamente., the expression is pasar olimpicamente.

See also

• Story #5.

Show sentence translation

As a Student I want to see on demand the translation for the sentence I work on, so that I could understand the meaning of it.

Acceptance criteria

Confirm that:

• a displayed sentence is clickable when its translation exists and not clickable otherwise;
• when clicked, a pop-up window with the translation of the sentence is shown;
• when the pop-up is shown, clicking anywhere outside of its area closes the pop-up.

Assumptions

• Foreign language is Spanish (es).
• Native language is English (en).

Tasks

• Update the specification.
• Add language code to the URI.
• Add optional translation link to Sentence resource.
• Add Angular Material.
• Update UI to make the link clickable when translation is available.
• Update UI to show a pop-up with translation.
• Publish specification.

See also

• ISO 639 language codes
• Story #2.
• Story #5.