[W09-4] QuickDocs

.gitignore

@@ -8,7 +8,7 @@ lib/*
 *.log
 *.log.*
 *.csv
-config.json
+/config.json
 src/test/data/sandbox/
 preferences.json
 .DS_Store

README.adoc

@@ -1,10 +1,9 @@
-= Address Book (Level 4)
+= QuickDocs
 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-AY1819S2-W09-4/main[image:https://travis-ci.org/CS2103-AY1819S2-W09-4/main.svg?branch=master[Build Status]]
+https://coveralls.io/github/CS2103-AY1819S2-W09-4[image:https://coveralls.io/repos/github/CS2103-AY1819S2-W09-4/main/badge.svg?branch=master[Coverage Status]]
+
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -14,26 +13,37 @@ 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.
+== What is QuickDocs
+
+*QuickDocs* is an all-in-one clinic management application intended for doctors operating family clinics in Singapore. It can
+facilitate and expedite clinical operations to help doctors overcome manpower limitations in their clinics, and improve the
+quality of healthcare services provided to the patients.
+
+*QuickDocs* is a desktop application with a graphical user interface (GUI) but most of the user interactions happen using
+a CLI (Command Line Interface). Therefore it is intended for doctors who can type fast and prefer a CLI to perform
+tasks.
+
+== What can QuickDocs do?
+
+*QuickDocs* can helps doctors with:
+
+* Managing patient data
+* Conducting consultation sessions with patients
+* Organizing patient appointment dates
+* Setting personal reminders
+* Maintaining the clinic's medicine inventory
+* Generating useful statistics on the clinic's operations
 
 == 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_.
+* QuickDocs is developed using the base code of https://github.com/nus-cs2103-AY1819S2/addressbook-level4/blob/master/README.adoc[AddressBook Level 4] provided by by the https://github.com/se-edu[se-edu team].
 * Libraries used: https://github.com/TestFX/TestFX[TextFX], 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,25 @@
+{
+	"authors":
+	[
+		{
+			"githubId": "simjiazhi",
+			"displayName": "SIM...ZHI",
+			"authorNames": ["simjiazhi"]
+		},
+		{
+			"githubId": "bentwj",
+			"displayName": "TAN...IAN",
+			"authorNames": ["bentwj"]
+		},
+		{
+			"githubId": "ongaaron96",
+			"displayName": "ONG...RON",
+			"authorNames": ["ongaaron96", "Aaron Ong"]
+		},
+		{
+			"githubId": "Xue-Chenyang",
+			"displayName": "XUE...ANG",
+			"authorNames": ["Xue-Chenyang"]
+		}
+	]
+}

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 = 'quickdocs.MainApp'
 
 sourceCompatibility = JavaVersion.VERSION_1_9
 targetCompatibility = JavaVersion.VERSION_1_9
@@ -77,7 +77,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'QuickDocs.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -152,16 +152,16 @@ test {
         }
 
         if (runNonGuiTests) {
-            test.include 'seedu/address/**'
+            test.include 'quickdocs/**'
         }
 
         if (runGuiTests) {
             test.include 'systemtests/**'
-            test.include 'seedu/address/ui/**'
+            test.include 'quickdocs/ui/**'
         }
 
         if (!runGuiTests) {
-            test.exclude 'seedu/address/ui/**'
+            test.exclude 'quickdocs/ui/**'
         }
     }
 }
@@ -202,7 +202,7 @@ 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-name': 'QuickDocs',
         'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]

docs/AboutUs.adoc

@@ -4,53 +4,46 @@
 :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.}_ +
-{empty} +
+Quickdocs was developed by the W09-4 team. +
+
 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>>]
+=== Sim Jia Zhi
+image::simjiazhi.png[width="150", align="left"]
+{empty}[https://github.com/simjiazhi[github]] [<<simjiazhi.adoc#, portfolio>>]
 
-Role: Project Advisor
+Role: Team Lead and deliverables +
+Responsibilities: Patient and consultation management module, UI design
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Tan Wenjian
+image::bentwj.png[width="150", align="left"]
+{empty}[http://github.com/bentwj[github]] [<<bentwj.adoc#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Code Quality and Documentation +
+Responsibilities: Administration and statistics module, Logic implementation
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Ong You Sheng Aaron
+image::ongaaron96.png[width="150", align="left"]
+{empty}[http://github.com/ongaaron96[github]] [<<ongaaron96.adoc#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Testing and Integration +
+Responsibilities: Appointment and reminder management module, Storage Management
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Xue Chenyang
+image::xue-chenyang.png[width="150", align="left"]
+{empty}[http://github.com/Xue-Chenyang[github]] [<<Xue-Chenyang.adoc#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Scheduling and Tracking +
+Responsibilities: Medical inventory management module, Model Management
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
-
-Role: Developer +
-Responsibilities: UI
-
 '''

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-AY1819S2-W09-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`
+* *Email us* : You can also reach us at `cs2103tw094 [at] gmail [DOT] com`