[CS2113-W14-4] Pharmacy Inventory & Logistics Ledger (PILL)

.gitignore

@@ -15,3 +15,10 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+# Local data and log files
+/data/
+/log/
+
+# Artifact manifest file
+/META-INF/

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# Pharmacy Inventory & Logistics Ledger (PILL)
 
 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.
 

build.gradle

@@ -29,7 +29,7 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.pill.Pill")
 }
 
 shadowJar {
@@ -41,6 +41,7 @@ checkstyle {
     toolVersion = '10.2'
 }
 
-run{
+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)
+Display | Name | Github Pofile | Portfolio
+--------|:----:|:-------------:|:--------:
+
+![](https://th.bing.com/th/id/OIP.4gUeSpMg2p-5Of2to-rb3gHaJl?rs=1&pid=ImgDetMain) | Benjamin Lim | [Github](https://github.com/yakultbottle) | [Portfolio](docs/team/yakultbottle.md)
+![](https://carrotsandcake.com/wp-content/uploads/2022/07/Among-Us-Symbol.png) | Zhang Yijian | [Github](https://github.com/yijiano) | [Portfolio](docs/team/yijiano.md)
+![](https://th.bing.com/th/id/OIP.GMzbuaCd00rCkkcGvd2GiQHaHa?rs=1&pid=ImgDetMain) | Nivedit | [Github](https://github.com/cnivedit) | [Portfolio](docs/team/cnivedit.md)
+![](https://th.bing.com/th/id/OIP.uoFjfZw1zxgaKZq6Mn4uJQHaJr?rs=1&pid=ImgDetMain) | Xinchi | [Github](https://github.com/cxc0418) | [Portfolio](docs/team/cxc0418.md)
+![](https://th.bing.com/th/id/OIP.FjosDChkMJNJSOVsiUSGlQHaJr?rs=1&pid=ImgDetMain) | Philip | [Github](https://github.com/philip1304) | [Portfolio](docs/team/philip1304.md)

docs/DeveloperGuide.md

@@ -1,5 +1,28 @@
 # Developer Guide
 
+## Table of Contents
+- [Developer Guide](#developer-guide)
+    - [Table of Contents](#table-of-contents)
+    - [Acknowledgements](#acknowledgements)
+    - [Design \& Implementation](#design--implementation)
+        - [UI and I/O](#ui-and-io)
+        - [Commands](#commands)
+        - [Storage](#storage)
+        - [Item and ItemMap](#item-and-itemmap)
+        - [DateTime](#datetime)
+        - [Exceptions and Logging](#exceptions-and-logging)
+    - [Product scope](#product-scope)
+        - [Target user profile](#target-user-profile)
+        - [Value proposition](#value-proposition)
+    - [User Stories](#user-stories)
+    - [Non-Functional Requirements](#non-functional-requirements)
+    - [Glossary](#glossary)
+    - [Instructions for Testing](#instructions-for-testing)
+        - [Manual Testing](#manual-testing)
+        - [JUnit Testing](#junit-testing)
+        - [Text UI Testing](#text-ui-testing)
+    - [Future Enhancements](#future-enhancements)
+
 ## Acknowledgements
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
@@ -8,6 +31,38 @@
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+### UI and I/O
+The program uses a command-line interface (CLI) for interaction with the user. 
+It receives input as text commands, processes these commands, and provides feedback through the console.
+
+### Commands
+Each user action (e.g. adding, deleting, or editing an item) is mapped to a specific command class. 
+These classes handle the logic for interpreting the input and calling the appropriate methods from the ItemMap and Storage classes.
+
+Example:
+```
+AddItemCommand command = new AddItemCommand(itemName, quantity, expiryDate);
+command.execute(itemMap, storage);
+```
+
+### Storage
+**API**: Storage.java
+
+Entries are stored in Comma Separated Values(CSV) format. Fields read from left
+to right are: **Item type**, **Quantity**, and **Expiry date**(optional). Items
+may or may not have an expiry date, but all possess an Item type and a Quantity. 
+
+Example of stored entries:
+```
+panadol,1
+panadol,30,2024-08-03
+panadol,20,2024-08-09
+bandage,34
+```
+
+The Storage class depends on self-defined classes PillException, Item, and
+ItemMap. While it has other dependencies, such as File and FileWriter from
+the Java standard library, PillException is the only custom class it depends on.
 
 ## Product scope
 ### Target user profile

docs/UserGuide.md

@@ -1,42 +1,154 @@
-# User Guide
+
+
+# Pharmacy Inventory & Logistics Ledger (PILL) User Guide
+
+**Version 1.0**
+
+1. [Introduction](#introduction)
+2. [Features](#features)
+    - [Viewing Help: `help`](#viewing-help-help)
+    - [Adding New Item: `add`](#adding-new-item-add)
+    - [Listing All Items: `list`](#listing-all-items-list)
+    - [Deleting Existing Item: `delete`](#deleting-existing-item-delete)
+    - [Exiting the Program: `exit`](#exiting-the-program-exit)
+    - [Saving the Data](#saving-the-data)
+    - [Editing the Data File](#editing-the-data-file)
 
 ## Introduction
 
-{Give a product intro}
+Pharmacy Inventory & Logistics Ledger (PILL) is a Command Line Interface (CLI) tool designed to assist in managing and tracking medicinal inventory.
+
+
+
+## Features
+
+### Viewing Help: `help`
+
+Displays a list of all available commands and their descriptions.
+
+**Format**: `help`
+
+**Sample Output**:
+
+`> help`
+
+```
+help
+- Displays a list of all available commands and their descriptions
+```
+
+```
+add n/NAME q/QUANTITY
+- Allows the user to add a new item to the inventory
+```
+
+```
+list
+- Shows all the items that have been added to the inventory
+```
+
+```
+delete INDEX 
+- Removes a specified item index from the inventory
+```
+
+```
+exit
+- Terminates the application
+```
+
+
+
+---
+
+### Adding New Item: `add`
+
+Adds a new item to the inventory, specifying its name and quantity.
+
+**Format**: `add n/NAME e/QUANTITY`
+
+**Sample Output**:
+
+`> add n/Panadol q/2`
+
+```
+Added the following item to the inventory:
+1. Panadol: 2 in stock
+```
+
+
+
+---
+
+### Listing All Items: `list`
+
+Displays a list of all items currently stored in the inventory, including their names and quantities.
+
+**Format**: `list`
+
+**Sample Output**:
+
+`> list`
+
+```
+1. Panadol: 2 in stock
+2. Ibuprofen: 1 in stock 
+```
+
+
+
+---
+
+### Deleting Existing Item: `delete`
+
+Deletes an existing item entry in the inventory.
+
+**Format**: `delete n/NAME`
+
+- Delete the items with specified`NAME` .
+
+**Example**:
+
+- `delete n/NAME`  
+  deletes the item as referenced in the `list`.
+
+**Sample Output**:
+
+`> delete n/Ibuprofen`
+
+```
+Deleted the following item from the inventory: 
+	2. Ibuprofen: 1
+```
+
+
 
-## Quick Start
+---
 
-{Give steps to get started quickly}
+### Exiting the Program: `exit`
 
-1. Ensure that you have Java 17 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+Exits the program.
 
-## Features 
+**Format**: `exit`
 
-{Give detailed description of each feature}
+**Sample Output**:
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+`> exit`
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+`Exiting the inventory interface. Have a nice day! :)`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
 
-Example of usage: 
 
-`todo n/Write the rest of the User Guide d/next week`
+---
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+### Saving the Data
 
-## FAQ
+The system automatically saves any changes to the inventory to the hard disk after commands that modify the data (e.g., `add`, `delete`). The data is also saved upon using the `exit` command. There is no need to manually save changes.
 
-**Q**: How do I transfer my data to another computer? 
 
-**A**: {your answer here}
 
-## Command Summary
+---
 
-{Give a 'cheat sheet' of commands here}
+### Editing the Data File
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+Inventory data is stored in a `.csv` file. Users can edit this file manually if necessary.

src/main/java/seedu/pill/Pill.java

@@ -0,0 +1,43 @@
+package seedu.pill;
+
+import seedu.pill.util.ItemMap;
+import seedu.pill.util.Parser;
+import seedu.pill.util.Printer;
+import seedu.pill.util.Storage;
+import seedu.pill.util.Ui;
+import seedu.pill.util.PillLogger;
+
+import seedu.pill.exceptions.PillException;
+
+import java.util.logging.Logger;
+
+public final class Pill {
+    private static final Storage storage = new Storage();
+    private static ItemMap items = new ItemMap();
+    private static final Ui ui = new Ui(items);
+    private static Parser parser = new Parser(items, storage);
+    private static final Logger logger = PillLogger.getLogger();
+
+    /**
+     * Runs the main loop of the Pill chatbot.
+     */
+    public void run() {
+        items = storage.loadData();
+        Printer.printInitMessage(items, 50);
+        parser = new Parser(items, storage);
+        logger.info("New Chatbot Conversation Created");
+        while (!parser.getExitFlag()) {
+            String line = ui.getInput();
+            parser.parseCommand(line);
+        }
+        Printer.printExitMessage();
+        logger.info("Chatbot Conversation Ended");
+    }
+
+    /**
+     * Main method to run the Pill bot.
+     */
+    public static void main(String[] args) throws PillException{
+        new Pill().run();
+    }
+}