[CS2103T-F12-2] VISIT

README.adoc

@@ -1,36 +1,92 @@
-= Address Book (Level 3)
-ifdef::env-github,env-browser[:relfileprefix: docs/]
+:notitle:
+++++
+<h1 align="center">
+  <br>
+  <a href="https://roc.ms/visitapp"><img src="https://github.com/AY1920S1-CS2103T-F12-2/main/raw/master/docs/images/icons/LogoTitle.png" alt="VISIT" width="400"></a>
+  <br>
+  VISIT
+  <br>
+</h1>
 
-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]]
+<h4 align="center">A Patient Tracking Application for Doctors On-The-Go.</h4>
 
-ifdef::env-github[]
-image::docs/images/Ui.png[width="600"]
-endif::[]
+<p align="center">
+  <a href="https://travis-ci.org/AY1920S1-CS2103T-F12-2/main"><img src="https://travis-ci.org/AY1920S1-CS2103T-F12-2/main.svg?branch=master"></a>
+  <a href='https://coveralls.io/github/AY1920S1-CS2103T-F12-2/main?branch=master'><img src='https://coveralls.io/repos/github/AY1920S1-CS2103T-F12-2/main/badge.svg?branch=master' alt='Coverage Status' /></a>
+</p>
 
-ifndef::env-github[]
-image::images/Ui.png[width="600"]
-endif::[]
+<p align="center">
+  <a href="#key-features">Key Features</a> •
+  <a href="#how-to-use">How To Use</a> •
+  <a href="#download">Download</a> •
+  <a href="#site-map">Site Map</a> •
+  <a href="#acknowledgements">Acknowledgements</a> •
+  <a href="#license">License</a>
+</p>
 
-* 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.
+<p align="center">
+<img src="https://github.com/AY1920S1-CS2103T-F12-2/main/raw/master/docs/images/Ui.png" alt="Ui.png" width="900">
+</p>
+
+++++
+
+== Key Features
+
+* Completely CLI-Friendly 💻
+** Prefer the keyboard? VISIT is made to be entirely operable just using your keyboard!
+* Patient Profiling 👪
+** Keep all the key patient details like names, addresses and contact information of your patients easily accessible.
+* Visit Tracking 🏠
+** Keep track of the history of past visits by the same patient to provide holistic and personalized healthcare.
+* Reminder System 📆
+** Can't remember when your next appointment is? VISIT reminds you when your next consultation is.
+* Alias / Macro command support
+* Tagging and Search functionality
+* Save patient information as a text file
+* Cross platform
+** Windows, macOS and Linux ready.
+
+== How To Use
+
+To run this application, you'll need  https://www.oracle.com/technetwork/java/javase/downloads/jdk11-downloads-5066655.html[Java 11] installed on your computer. +
+Run the program then, try typing the following commands:
+
+[source, sh]
+----
+# Adds a Patient with details
+$ add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01
+
+# Adds a visitation report
+$ addVisit n/Betsy Crowe t/12/12/12 e/[email protected]
+
+# Find all patients matched to the query 'John', 'Tim' or 'Betsy'
+$ find John Tim Betsy
+
+# Show the full profile of the patient at position 1
+$ profile 1
+----
+
+For other commands, check out our User Guide at link:https://github.com/AY1920S1-CS2103T-F12-2/main/blob/master/docs/UserGuide.adoc[here]!
+
+== Download
+
+You can https://github.com/AY1920S1-CS2103T-F12-2/main/releases[download] the latest installable version of VISIT for Windows, macOS and Linux.
 
 == Site Map
 
-* <<UserGuide#, User Guide>>
-* <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
-* <<AboutUs#, About Us>>
-* <<ContactUs#, Contact Us>>
+* link:https://github.com/AY1920S1-CS2103T-F12-2/main/blob/master/docs/AboutUs.adoc[About Us]
+* link:https://github.com/AY1920S1-CS2103T-F12-2/main/blob/master/docs/ContactUs.adoc[Contact Us]
+* link:https://github.com/AY1920S1-CS2103T-F12-2/main/blob/master/docs/UserGuide.adoc[User Guide]
+* link:https://github.com/AY1920S1-CS2103T-F12-2/main/blob/master/docs/DeveloperGuide.adoc[Developer Guide]
 
 == 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 is built upon 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://github.com/junit-team/junit5[JUnit5]
+
+== License
 
-== Licence : link:LICENSE[MIT]
+link:LICENSE[MIT]

build.gradle

@@ -133,9 +133,9 @@ 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': 'VISIT',
+        'site-githuburl': 'https://github.com/AY1920S1-CS2103T-F12-2/main',
+        'untitled-label': 'VISIT by Team UnityUnreal'
     ]
 
     options['template_dirs'].each {

docs/AboutUs.adoc

@@ -4,53 +4,61 @@
 :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} +
-We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
+VISIT is an Address Book application for Doctors to plan their visits to patients. Doctors can have granular control over each visit, log each diagnosis, schedule follow-up with patients, and keep track of their appointments.
+
+We are Team https://github.com/AY1920S1-CS2103T-F12-2[UnrealUnity] 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>>]
+=== Chattoraj Ayush
+image::ayushchatto.png[width="150", align="left"]
+{empty}[https://github.com/AyushChatto[github]] [<<AyushChatto#, portfolio>>]
 
-Role: Project Advisor
+Role: Project Advisor / Consultant
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Jason Chee
+image::reignofcomputer.png[width="150", align="left"]
+{empty}[https://www.reignofcomputer.com/[homepage]] [http://github.com/reignofcomputer[github]] [<<reignofcomputer#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Team Lead / Managing Director +
+Responsibilities: Project Manager, Developer, Legal & Compliance, Security, In charge of `Reminder-Follow-Up` Component
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Gabriel Chia
+image::gachia.png[width="150", align="left"]
+{empty}[http://github.com/gachia[github]] [<<gabrielchia#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: UI, Documentation, Concept Artist
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Jerrold Tan
+image::wingedevil.png[width="150", align="left"]
+{empty}[http://github.com/Wingedevil[github]] [<<jerroldtan#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Git Expert, In charge of ‘Alias’ Component
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Zheng Shi Qiao
+image::sqwq.png[width="150", align="left"]
+{empty}[http://github.com/SQwQ[github]] [<<SQwQ#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: IntelliJ Expert, Documentation, In charge of `Visit` Component
+
+'''
+
+=== Gabriel Ong
+image::q-gabe.png[width="150", align="left"]
+{empty}[https://q-gabe.me[homepage]] [http://github.com/q-gabe[github]] [<<q-gabe#, portfolio>>]
+
+Role: Developer / Tester +
+Responsibilities: Integration, Documentation, In charge of `ProfileView` Component
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,6 @@
 :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.
-* *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`
+* *Bug Reports & Suggestions*: If you notice any bugs or have any suggestions on how we can improve, please post on our https://github.com/AY1920S1-CS2103T-F12-2/main/issues[issue tracker].
+* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here].
+* *Email us* : You can also reach us at `visit [at] roc.ms`.

docs/DevOps.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= VISIT - 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-F12-2/main/tree/master
 
 == Build Automation