[T10-3] LearnVocabulary

.gitignore

@@ -18,3 +18,4 @@ classes/
 /bin/
 src/main/resources/docs/
 out/
+!_reposense/config.json

LICENSE

@@ -2,11 +2,11 @@ MIT License
 
 Copyright (c) 2016 Software Engineering Education - FOSS Resources
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any word obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
+copies of the Software, and to permit words to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all

README.adoc

@@ -1,10 +1,8 @@
-= Address Book (Level 4)
+= LearnVocabulary
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
+https://travis-ci.org/CS2103-AY1819S1-T10-3/main[image:https://travis-ci.org/CS2103-AY1819S1-T10-3/main.svg?branch=master[Build Status]]
+https://coveralls.io/github/CS2103-AY1819S1-T10-3/main?branch=master[image:https://coveralls.io/repos/github/CS2103-AY1819S1-T10-3/main/badge.svg?branch=master[Coverage Status]]
 https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
 
 ifdef::env-github[]
@@ -15,26 +13,21 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
-* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
-** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
+== Introduction
+
+LearnVocuabulary is a desktop application for people who prefer to use an offline version of the dictionary for learning purposes. More importantly, LearnVocuabulary is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). With LearnVocabulary you can make digital flash-cards of words you find troublesome, and discard them only after you have memorized the meaning. LearnVocuabulary can fetch the words faster than searching it on the website. Enjoy!
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
-* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
-_Marco Jakob_.
+* The original source of the code is taken from AddressBook-Level4 project, created by SE-EDU initiative at https://github.com/se-edu/
+
 * Libraries used: https://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
 
 == Licence : link:LICENSE[MIT]

_reposense/config.json

@@ -0,0 +1,26 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "russellong95",
+      "displayName": "Russell",
+      "authorNames": ["Russell Ong"]
+    },
+    {
+      "githubId": "alexehrs",
+      "displayName": "Alexander",
+      "authorNames": ["Alexander Ehrs"]
+    },
+    {
+      "githubId": "danielkoh94",
+      "displayName": "Daniel",
+      "authorNames": ["Daniel Koh"]
+    },
+    {
+      "githubId": "Harryqu123",
+      "displayName": "Haoxuan",
+      "authorNames": ["Qu Haoxuan"]
+    }
+
+  ]
+}

build.gradle

@@ -28,7 +28,7 @@ if (JavaVersion.current() == JavaVersion.VERSION_1_10
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.MainApp'
+mainClassName = 'seedu.learnvocabulary.MainApp'
 
 sourceCompatibility = JavaVersion.VERSION_1_9
 targetCompatibility = JavaVersion.VERSION_1_9
@@ -55,6 +55,8 @@ test {
 }
 
 dependencies {
+    compile 'org.jsoup:jsoup:1.11.3'
+
     String testFxVersion = '4.0.12-alpha'
     String jUnitVersion = '5.1.0'
 
@@ -82,7 +84,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'learnvocabulary.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -157,16 +159,16 @@ test {
         }
 
         if (runNonGuiTests) {
-            test.include 'seedu/address/**'
+            test.include 'seedu/learnvocabulary/**'
         }
 
         if (runGuiTests) {
             test.include 'systemtests/**'
-            test.include 'seedu/address/ui/**'
+            test.include 'seedu/learnvocabulary/ui/**'
         }
 
         if (!runGuiTests) {
-            test.exclude 'seedu/address/ui/**'
+            test.exclude 'seedu/learnvocabulary/ui/**'
         }
     }
 }
@@ -207,8 +209,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level4',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
+        'site-name': 'LearnV',
+        'site-githuburl': 'https://github.com/CS2103-AY1819S1-T10-3/main',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 
@@ -237,7 +239,7 @@ task deployOfflineDocs(type: Copy) {
 }
 
 task copyDummySearchPage(type: Copy) {
-    from 'docs/DummySearchPage.html'
+    from 'src/main/resources/view/WordSearchPage.html'
     into "${buildDir}/docs/html5"
 }
 

config.json

@@ -0,0 +1,5 @@
+{
+  "appTitle" : "LearnVocabulary",
+  "logLevel" : "INFO",
+  "userPrefsFilePath" : "preferences.json"
+}

copyright.txt

@@ -1,9 +1,11 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
 Copyright by Susumu Yoshida - http://www.mcdodesign.com/
-- address_book_32.png
 - AddressApp.ico
 
 Copyright by Jan Jan Kovařík - http://glyphicons.com/
 - calendar.png
 - edit.png
+
+Copyright by dtafalonso - http://www.iconarchive.com/
+- learnvocabulary_32.png

docs/AboutUs.adoc

@@ -4,53 +4,40 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
+LearnVocabulary was developed by the T10-3 team. +
 {empty} +
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
-
-Role: Project Advisor
-
-'''
-
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
-
-Role: Team Lead +
-Responsibilities: UI
+=== Haoxuan
+image::harryqu123.png[width="150", align="left"]
+{empty}[https://github.com/Harryqu123[github]][<<harryqu123#, portfolio>>]
 
+In charge of: Deliverables and deadlines +
+Responsibilities: Ensure things are not done at last minute.
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
-
-Role: Developer +
-Responsibilities: Data
+=== Alexander Ehrs
+image::alexehrs.png[width="150", align="left"]
+{empty}[http://github.com/alexehrs[github]][<<alexehrs#, portfolio>>]
 
+In charge of: Documentation +
+Responsibilities: Ensures documentation done properly.
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
-
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+=== Russell Ong
+image::russellong95.png[width="150", align="left"]
+{empty}[https://github.com/russellong95[github]][<<russellong95#, portfolio>>]
 
+In charge of: Team Lead, Testing and Integration +
+Responsibilities: Responsible for overall project coordination, ensure testing quality.
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
-
-Role: Developer +
-Responsibilities: UI
+=== Daniel Koh
+image::danielkoh94.png[width="160", align="left"]
+{empty}[https://github.com/danielkoh94[github]][<<danielkoh94#, portfolio>>]
 
+In charge of: Coding Quality +
+Responsibilities: Ensures code is of quality.
 '''

docs/ContactUs.adoc

@@ -2,6 +2,6 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Bug reports, Suggestions* : Post in our https://github.com/CS2103-AY1819S1-T10-3/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
 * *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+* *Email us* : You can also reach us at `alexander.ehrs [at] gmail.com`, `haoxuanqu [at] gmail.com`, `digivicer [at] hotmail.com`, `danielkoh554 [at] hotmail.com`.