wordstudent

Word learning program
git clone git://git.wimdupont.com/wordstudent.git
Log | Files | Refs | LICENSE

README.adoc (994B)

      1 = WordStudent
      2 
      3 Looks up words (saved in csv-file) in https://dictionaryapi.dev[dictionary API] and persists the data in https://couchdb.apache.org/[CouchDB] database.
      4 Words are not looked up with api on subsequent runs unless it is removed from the database.
      5 
      6 Words are randomly shuffled each run.
      7 
      8 Navigation:
      9 
     10 * Use the "Show" button ("j", "down", "space") to show meaning of given word.
     11 * Use the "Next" button ("l", "right") to go to next word.
     12 * Use the "Previous" button ("h", "left") to return to previous word.
     13 
     14 == Setup
     15 
     16 . Create a csv file with words to learn; separated by new lines and/or semicolons
     17 . Create application.properties file under src/main/resources with following properties:
     18 .. 'csv.dir': path of the csv file
     19 .. 'couchdb.connection-url': couchDb url (example: http://localhost:5984/wordtester)
     20 .. 'dictionary.client.connection-url': api url (https://api.dictionaryapi.dev/api/v2/entries/en/)
     21 
     22 == Run
     23 
     24 . $ mvn package
     25 . $ java -jar target/WordStudent-1.0-SNAPSHOT.jar