[CS2103T-T13-4] Mark

README.adoc

@@ -1,36 +1,44 @@
-= Address Book (Level 3)
+= Mark
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
-https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+https://travis-ci.org/AY1920S1-CS2103T-T13-4/main[image:https://travis-ci.org/AY1920S1-CS2103T-T13-4/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/Na-Nazhou/main-s7pnr[image:https://ci.appveyor.com/api/projects/status/uudh03pfcj3d2skk?svg=true[Build status]]
+https://coveralls.io/github/AY1920S1-CS2103T-T13-4/main?branch=master[image:https://coveralls.io/repos/github/AY1920S1-CS2103T-T13-4/main/badge.svg?branch=master[Coverage Status]]
+https://www.codacy.com/manual/Na-Nazhou/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S1-CS2103T-T13-4/main&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/acdf3b37edfe40dbab7320f740928c89[Codacy Badge]]
 
 ifdef::env-github[]
-image::docs/images/Ui.png[width="600"]
+image::images/Ui.png[]
 endif::[]
 
 ifndef::env-github[]
-image::images/Ui.png[width="600"]
+image::images/Ui.png[]
 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.
+
+== About Mark
+
+Mark::
+An intuitive bookmark manager made by people who love to type, for people who love to type.
+
+****
+*Special Features*:
+
+* Save important content from a webpage for *offline* use, and *annotate* it right away.
+* Set *reminders* for websites. Never forget to pay those pesky e-bills again!
+* Sort and tag your bookmarks automatically with our intelligent *auto-tagging* system. Keeping your bookmarks organized is easy.
+****
 
 == 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_.
-* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+* This application was inspired by the AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
+* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://jsoup.org/[JSoup],
+https://github.com/junit-team/junit5[JUnit5], https://github.com/dankito/Readability4J[Readability4J]
 
 == Licence : link:LICENSE[MIT]

build.gradle

@@ -15,7 +15,7 @@ plugins {
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.mark.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -43,7 +43,7 @@ test {
 
 dependencies {
     String jUnitVersion = '5.4.0'
-    String javaFxVersion = '11'
+    String javaFxVersion = '11.0.2'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
@@ -57,17 +57,28 @@ dependencies {
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'linux'
+    //use for reminder notification
+    implementation 'org.controlsfx:controlsfx:11.0.1-SNAPSHOT'
 
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
+    compile group: 'org.jsoup', name: 'jsoup', version: '1.9.1'
+    compile 'net.dankito.readability4j:readability4j:1.0.3'
+
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'mark.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -97,6 +108,10 @@ tasks.coveralls {
     onlyIf { System.env.'CI' }
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     testLogging {
         events TestLogEvent.FAILED, TestLogEvent.SKIPPED
@@ -133,9 +148,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level3',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level3',
-        'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
+        'site-name': 'Mark',
+        'site-githuburl': 'https://github.com/AY1920S1-CS2103T-T13-4/main',
     ]
 
     options['template_dirs'].each {

copyright.txt

@@ -7,3 +7,6 @@ Copyright by Susumu Yoshida - http://www.mcdodesign.com/
 Copyright by Jan Jan Kovařík - http://glyphicons.com/
 - calendar.png
 - edit.png
+
+Icon made by Smashicons - https://www.flaticon.com/authors/smashicons from www.flaticon.com
+- bookmark_icon.png

docs/AboutUs.adoc

@@ -4,53 +4,52 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 3 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.}_ +
-{empty} +
+Mark was developed by the team https://github.com/orgs/AY1920S1-CS2103T-T13-4/teams/developers[CS2103T-T13-4]. +
 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>>]
+=== Dorcas Tabitha Tan
+image::dorcastan.png[width="150", align="left"]
+{empty}[https://github.com/dorcastan[github]] [<<dorcastan#, portfolio>>]
 
-Role: Project Advisor
+Role: Team lead, Scheduling & Tracking +
+Responsibilities: Model component, Autotag implementation
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Daryl Tan
+image::openorclose.png[width="150", align="left"]
+{empty}[https://github.com/openorclose[github]] [<<openorclose#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Testing & Code Quality +
+Responsibilities: Storage
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Na Nazhou
+image::na-nazhou.png[width="150", align="left"]
+{empty}[https://github.com/Na-Nazhou[github]] [<<na-nazhou#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Deliverables and Deadlines +
+Responsibilities: Logic
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Yoke Kai Xin
+image::kxyoke.png[width="150", align="left"]
+{empty}[https://github.com/kxyoke[github]] [<<kxyoke#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Documentation +
+Responsibilities: UI
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== TSAI, HSIAO-HAN
+image::tsai-hsiao-han.png[width="150", align="left"]
+{empty}[https://github.com/TSAI-HSIAO-HAN[github]] [<<TSAI-HSIAO-HAN#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: Integration +
+Responsibilities: Commons
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,5 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S1-CS2103T-T13-4/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`

docs/DevOps.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= Mark - Dev Ops
 :site-section: DeveloperGuide
 :toc:
 :toc-title:
@@ -12,7 +12,7 @@ ifdef::env-github[]
 :note-caption: :information_source:
 :warning-caption: :warning:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
+:repoURL: https://github.com/AY1920S1-CS2103T-T13-4/main/tree/master
 
 == Build Automation
 
@@ -34,14 +34,14 @@ When a pull request has changes to asciidoc files, you can use https://www.netli
 
 Here are the steps to create a new release.
 
-.  Update the version number in link:{repoURL}/src/main/java/seedu/address/MainApp.java[`MainApp.java`].
+.  Update the version number in link:{repoURL}/src/main/java/seedu/mark/MainApp.java[`MainApp.java`].
 .  Generate a JAR file <<UsingGradle#creating-the-jar-file, using Gradle>>.
 .  Tag the repo with the version number. e.g. `v0.1`
 .  https://help.github.com/articles/creating-releases/[Create a new release using GitHub] and upload the JAR file you created.
 
 == Managing Dependencies
 
-A project often depends on third-party libraries. For example, Address Book depends on the https://github.com/FasterXML/jackson[Jackson library] for JSON parsing. Managing these _dependencies_ can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives:
+A project often depends on third-party libraries. For example, Mark depends on the https://github.com/FasterXML/jackson[Jackson library] for JSON parsing. Managing these _dependencies_ can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives:
 
 [loweralpha]
 . Include those libraries in the repo (this bloats the repo size)