[CS2113-T16-4] Hospitalsaurus Rex

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+
+/data/

README.md

@@ -1,28 +1,32 @@
-# Duke project template
+# Hospitalsaurus ReX project
 
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
+This is a Hospitalsaurus ReX project. Given below are instructions on how to use it.
 
 ## Setting up in Intellij
 
 Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
 
 1. **Configure Intellij for JDK 11**, as described [here](https://se-education.org/guides/tutorials/intellijJdk.html).
 1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/rex/Rex.java` file, right-click it, and choose `Run Rex.main()`. If the setup is correct, you should see something like the below:
    ```
-   > Task :compileJava
+   > Task :compileJava UP-TO-DATE
    > Task :processResources NO-SOURCE
-   > Task :classes
+   > Task :classes UP-TO-DATE
 
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
+   > Task :Rex.main()
+   	____________________________________________________________
+   	  _    _                 _ _        _                                  _____     __   __
+   	 | |  | |               (_| |      | |                                |  __ \    \ \ / /
+   	 | |__| | ___  ___ _ __  _| |_ __ _| |___  __ _ _   _ _ __ _   _ ___  | |__) |___ \ V /
+   	 |  __  |/ _ \/ __| '_ \| | __/ _` | / __|/ _` | | | | '__| | | / __| |  _  // _ \ > <  
+   	 | |  | | (_) \__ | |_) | | || (_| | \__ | (_| | |_| | |  | |_| \__ \ | | \ |  __// . \
+   	 |_|  |_|\___/|___| .__/|_|\__\__,_|_|___/\__,_|\__,_|_|   \__,_|___/ |_|  \_\___/_/ \_\
+   	                  | |                                                                   
+   	                  |_|
+   	 How may i assist you?
+   	____________________________________________________________
+   	 Enter command: 
    ```
    Type some word and press enter to let the execution proceed to the end.
 
@@ -39,7 +43,7 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 
 ### JUnit tests
 
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
+* A skeleton JUnit test (`src/test/java/seedu/rex/RexTest.java`) is provided with this project template. 
 * If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
 
 ## Checkstyle

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.rex.Rex"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "rex"
     archiveClassifier = null
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,10 @@
 # About us
 
+
 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) | Tan Jun Hong | [Github](https://github.com/TanJunHong) | [Portfolio](docs/team/tanjunhong.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Liew You Sheng | [Github](https://github.com/GoldenCorgi) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Randy Ng | [Github](https://github.com/randynyl/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Chong Yow Lim | [Github](https://github.com/ychong032) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Tan Kiat Hwe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -4,31 +4,95 @@
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+The app was mainly inspired by [addressbook-level2](https://github.com/se-edu/addressbook-level2).
+
+### Design
+The App consists of a few main components.
+
+* Ui: The UI that deals with getting user input and displaying output.
+* Command: Command to be executed.
+* Parser: Parse user input and make sense of it.
+* Storage: Reads data from, and writes data to, the hard disk.
+* Rex: The main class that initialize the app and starts running.
+
+The rest are just objects that the app requires.
+
+The diagram below shows the basic design.
+![image info](./pictures/UML.png)
+
+The complete class diagram is shown below.
+![image info](./pictures/classDiagram.PNG)
+
+### Implementation
+#### Retrieve Command
+The flow for the retrieve command is as follows:
+![image info](./pictures/retrieveCommandSD.png)
+1. Retrieve command extracts NRIC using parser, 
+2. Retrieve command searches through the patients list and obtains the patient's index.
+3. Patients list returns the patient.
+4. Ui object prints the patient.
+
+#### Add Command
+The flow for add command is as follows:
+![image_info](./pictures/addCommandSD.PNG)
+1. Add command extracts NRIC by calling its own method.
+2. Add command checks patients list if NRIC already exists. Add command ends if so.
+3. Add command calls Ui object to get the patient name and date of birth from user.
+4. Patient list adds the new patient.
+5. Add command obtains the newly added patient.
+6. Ui receives the call to print the patient.
+7. The updated patients list is saved by the Storage object.
+
+
+#### Book Command
+The flow for the book command is shown in the sequence diagram below:
+![image info](./pictures/bookApptSequenceDiagram.PNG)
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+Administrative staff of hospitals who are overworked from having various responsibilities with repetitive tasks relating to doctors and patients.
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+Aim: To facilitate the role of the administrative staff and help them automate most of the mundane tasks that they have to do. This enables the admin staff to have a one stop application to handle appointments and fees across different specialised clinics in the hospital. Administrative staff will have more time to help patients or do things that are more meaningful, such as answering queries from patients or doctors.
 
 ## User Stories
 
 |Version| As a ... | I want to ... | So that I can ...|
 |--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+|v1.0|admin|enter patient's details and store it|refer to them whenever I require them.|
+|v1.0|admin|retrieve patient's details|use them to schedule appointments.|
+|v1.0|admin|remove existing patient's details|remove unnecessary information.|
+|v1.0|admin|view all appointments of a patient|remind patients of their appointments.|
+|v1.0|admin|book an appointment for a patient|let them see the doctor.|
+|v2.0|admin|add doctor|link doctor to appointment.|
+|v2.0|admin|remove existing doctor's details|remove unnecessary information.|
+|v2.0|admin|list patients|view patients.|
+|v2.0|admin|edit appointments|update them.|
 
 ## Non-Functional Requirements
 
-{Give non-functional requirements}
+* The program must be easy for admins to use.
+* The program must store patient's information.
+* The program must store doctor's information.
+* The program should run on any system running Java 11.
 
 ## Glossary
 
-* *glossary item* - Definition
+* *Hospitalsarus Rex* - The name of the program
 
 ## Instructions for manual testing
 
-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+### Initial setup
+1. Download the jar file and copy it into an empty directory
+2. Open command prompt, and point it to that directory
+3. Type in `java -jar Rex.jar` to run the file
+### Deleting a patient
+There must a patient in the list.
+1. `delete 1` - Deletes the patient at the first index
+2. `delete 0` - It should throw error and not delete a patient.
+### Adding a patient
+1. `add S9999999D` - Adds a patient with NRIC `S9999999D` to the list.
+2. `add S9999999D` - It should not add a patient and throw error as patient already exists.
+3. `add cat` - It should throw error and not add patients as it is invalid NRIC.

docs/README.md

@@ -1,4 +1,4 @@
-# Duke
+# Hospitalsaurus ReX
 
 {Give product intro here}