[CS2113T-T12-2] HappyPills

.gitignore

@@ -13,4 +13,11 @@ src/main/resources/docs/
 *.iml
 bin/
 
-/text-ui-test/ACTUAL.txt
+/text-ui-test/ACTUAL.txt
+/text-ui-test/data/
+
+/build/libs/data
+
+# data files
+/data/
+text-ui-test/data/patient.txt

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-architect

build.gradle

@@ -21,7 +21,7 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.happypills.HappyPills"
 }
 
 shadowJar {
@@ -37,4 +37,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -2,8 +2,7 @@
 
 Display | Name | Github Profile | Portfolio 
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Nyan Wun Paing | [Github](https://github.com/NyanWunPaing) | [Portfolio](docs/team/Nyan.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Janice| [Github](https://github.com/Janicetyy/tp) | [Portfolio](docs/team/janice.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Yap Kesin | [Github](https://github.com/itskesin) | [Portfolio](docs/team/Kesin.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Siti Nadiah | [Github](https://github.com/sitinadiah25) | [Portfolio](docs/team/sitinadiah.md)

docs/README.md

@@ -1,8 +1,13 @@
-# Duke
+# HappyPills
+HappyPills is a note-taking application that allows doctors to take down notes using Command Line Interface (CLI).
+
+The application replaces all physical papers and is highly optimised for fast typing users.    
+If you can type fast, HappyPills can help to manage patients’ records **faster** than traditional Graphical User Interface (GUI) applications.  
+All notes are **neatly organised** in HappyPills so that all your important information are **safely stored**.  
+Say **HELLO** to neater desks and time-saving electronic notes with HappyPills! <span style='font-size:20px;'>&#128522;</span>
 
-{Give product intro here}
 
-Useful links:
+## Useful links:
 * [User Guide](UserGuide.md)
-* [Developer Guide](UserGuide.md)
+* [Developer Guide](DeveloperGuide.md)
 * [About Us](AboutUs.md)

docs/SettingUp.md

@@ -0,0 +1,46 @@
+#HappyPills - Setting Up
+
+### 1. Prerequisites
+
+1.  JDK 11 or above
+
+2.  IntelliJ IDE
+ <table>
+   <col width="20">
+   <col width="200">
+  <tr>
+    <td><span> &#8505; </span></td>
+    <td>IntelliJ by default has Gradle and JavaFx plugins installed. Do not disable them. 
+    If you have disabled them, go to <code>File</code> > <code>Settings</code> > 
+    <code>Plugins</code> to re-enable them.</td>
+  </tr>
+ </table>
+
+### 2. Setting up the project on your computer
+1.  Fork this repository, and clone the fork to your computer
+
+2.  Open the IntelliJ IDE. If you are not in the welcome screen, click `File` &gt; `Close Project` to close the existing project.
+
+3.  Set up the correct JDK version for Gradle
+
+    1.  Click `Configure` &gt; `Project Defaults` &gt; `Project Structure`
+
+    2.  Click `New...` and find the directory of the JDK
+
+4.  Click on `Import Project`
+
+5.  Locate and select the `build.gradle` file, then click `OK`
+
+6.  Click `Open as Project`
+
+7.  Click `OK` to use the default settings provided
+
+### 3. Verifying the Setup
+1.  In Intellij, run `seedu.happypills.HappyPills` and try a few commands.
+    * Commands that you can try to get familiar with HappyPills:
+        - `help`: list all the available commands in HappyPills
+        - `add patient /ic S9876543F /n Eve /p 91265432 /dob 22/05/1999 /b O- /a School /rm Best Friend with Mallory`:
+        Add patient's information in HappyPills.
+        - `list patient`: list all the patients stored in HappyPills.
+
+

docs/Testing.md

@@ -0,0 +1,28 @@
+# HappyPills - Testing
+
+### Running Tests
+There are two ways to run tests.
+
+#### Method 1 : Using IntelliJ JUnit Tests
+- To run all test, right-click on `src/test/java` folder and choose `Run 'Tests in HappyPills'`
+- To run a subset of tests, you can right-click on a test package, test class, or a test and choose `Run 'TEST'`.
+
+#### Method 2 : Using Gradle
+- To run all test using Gradle: Open a terminal and run the command `gradlew clean test` 
+(Mac/Linux: `./gradlew clean test`)  
+  <table>
+    <col width="20">
+    <col width="200">
+   <tr>
+     <td><span> &#8505; </span></td>  
+     <td> See <a href="https://github.com/AY1920S2-CS2113T-T12-2/tp/blob/master/tutorials/gradleTutorial.md">Gradle Tutorial</a> 
+     for more info on how to run tests using Gradle. </td>
+     </td>
+   </tr>
+  </table>
+
+### Using Input-Output Tests
+- Right-click on `text-ui-test` folder and choose `Open in terminal` 
+- Enters `runtest.bat` (Windows) or `runtest.sh` (Mac / Linux) in the terminal to run the script.
+- This will run HappyPills with the commands given in the `input.txt` and compare its output in the `ACTUAL.txt` 
+with the `EXPECTED.txt`.

docs/UML/AddCommandActivityDiagram.puml

@@ -0,0 +1,13 @@
+@startuml
+(*)  --> "Add input command"
+If "add command parsed successfully" then
+--> [Yes] "Executes add command"
+--> "Patient information is added"
+--> "Patient list is updated
+        with the new patient"
+-->(*)
+else
+--> [No] "Throws Exception"
+Endif
+-->(*)
+@enduml

docs/UML/ArchitectureDiagram.puml

@@ -0,0 +1,33 @@
+@startuml
+!include <office/Concepts/globe_internet>
+!include <office/Concepts/documents>
+!include <office/Users/user>
+!include style.puml
+
+Package " "<<Rectangle>>{
+    Class UI UI_COLOR
+    Class Logic LOGIC_COLOR
+    Class Storage STORAGE_COLOR
+    Class Model MODEL_COLOR
+    Class Main MODEL_COLOR_T1
+    Class Hidden #FFFFFF
+    Class HiddenUI #FFFFFF
+    Class HiddenModel #FFFFFF
+}
+Class "<$user>" as User MODEL_COLOR_T2
+Class "<$documents>" as File UI_COLOR_T1
+
+
+HiddenUI -up[hidden]-> UI
+HiddenModel -left[hidden]-> Model
+Main -up-> HiddenUI
+Main -left-> HiddenModel
+UI -> Logic
+UI -right-> Model
+Logic -> Storage
+Logic -down-> Model
+
+Storage .right.>File
+User --> UI
+Main --> Hidden
+@enduml

docs/UML/ArchitectureSequenceDiagram.puml

@@ -0,0 +1,41 @@
+@startuml
+!include style.puml
+
+Actor User as user USER_COLOR
+Participant ":Main" as main MODEL_COLOR_T1
+Participant ":UI" as ui UI_COLOR
+Participant ":Logic" as logic LOGIC_COLOR
+Participant ":Model" as model MODEL_COLOR
+Participant ":Storage" as storage STORAGE_COLOR
+
+user -[USER_COLOR]> main : "list patient"
+activate main MODEL_COLOR_T1
+
+main -[USER_COLOR]> ui : "list patient"
+activate ui UI_COLOR
+
+ui -[UI_COLOR]> logic : execute("list patient")
+activate logic LOGIC_COLOR
+
+logic -[LOGIC_COLOR]> model : deletePerson(p)
+activate model MODEL_COLOR
+
+model -[MODEL_COLOR]-> logic
+deactivate model
+
+logic -[LOGIC_COLOR]> storage : saveAddressBook(addressBook)
+activate storage STORAGE_COLOR
+
+storage -[STORAGE_COLOR]> storage : Save to file
+activate storage STORAGE_COLOR_T1
+deactivate storage
+
+storage --[STORAGE_COLOR]> logic
+deactivate storage
+
+logic --[LOGIC_COLOR]> ui
+deactivate logic
+
+ui--[UI_COLOR]> user
+deactivate ui
+@enduml

docs/UML/Logic.puml

@@ -0,0 +1,47 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor LOGIC_COLOR_T4
+skinparam classBackgroundColor LOGIC_COLOR
+skinparam linetype ortho
+
+package Logic {
+
+package Parser {
+Interface Parser <<Interface>>
+Class PatientCommandParser
+Class AppointmentParser
+Class PatientRecordParser
+}
+
+package Command {
+Class PatientCommand
+Class AppointmentCommand
+Class PatientRecordCommand
+Class "{abstract}\nCommand" as Command
+}
+
+package Model{
+Class HiddenModel #FFFFFF
+}
+
+Class HiddenOutside #FFFFFF
+HiddenOutside ..> Parser
+
+PatientCommandParser .down.> PatientCommand : creates >
+AppointmentParser ....down.> AppointmentCommand : creates >
+PatientRecordParser .down.> PatientRecordCommand: creates >
+PatientRecordParser ..left[hidden].>PatientCommandParser
+
+PatientCommandParser ..up|> Parser
+AppointmentParser ..up|> Parser
+PatientRecordParser ..up|> Parser
+
+PatientCommand ......up.|> Command
+AppointmentCommand .up.|> Command
+PatientRecordCommand ....up.|> Command
+
+AppointmentCommand ..> Model
+PatientCommand ..> Model
+PatientRecordCommand ..> Model
+@enduml

docs/UML/Model.puml

@@ -0,0 +1,65 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor MODEL_COLOR
+skinparam classBackgroundColor MODEL_COLOR
+skinparam linetype ortho
+
+Package Model <<Rectangle>>{
+
+Package Patient {
+Class Person
+Class DOB
+Class BloodType
+Class NRIC
+Class Name
+Class Phone
+Class PatientList
+}
+
+Package Appointment {
+Class ApptList
+Class Appt
+Class Time
+Class ApptDate
+Class Reason
+}
+
+Package PatientRecord {
+Class PatientRecordList
+Class Pr
+Class Allergies
+Class Symptoms
+Class Prescription
+Class VisitDate
+}
+}
+
+Class HiddenOutside #FFFFFF
+
+PatientList o--> "*" Person
+Person *--> Name
+Person *--> Phone
+Person *--> BloodType
+Person *--> DOB
+Person *--> NRIC
+Person *-right-> "*" Appt
+
+ApptList o--> "*" Appt
+Appt *--> Time
+Appt *--> ApptDate
+Appt *--> Reason
+
+PatientRecordList o--> "*" Pr
+Pr *--> Allergies
+Pr *--> Symptoms
+Pr *--> Prescription
+Pr *--> VisitDate
+
+Person *-left-> "*" Pr
+
+Name --[hidden]right-> Phone
+Phone --[hidden]right-> DOB
+DOB --[hidden]right-> BloodType
+
+@enduml