forked from nus-cs2113-AY2324S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #309 from DextheChik3n/293-draft-ppp-v2.1
293 draft ppp v2.1
- Loading branch information
Showing
8 changed files
with
64 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Dexter Hoon's Project Portfolio Page | ||
## Project: CafeCRTL | ||
|
||
----------------------------------------------------------------------------------------------- | ||
### **Overview** | ||
CaféCTRL aims to optimize managing of inventory and cash flow in a restaurant. Our CLI platform also empowers users to streamline stock inventory, menu and orders. The user interacts with it using a CLI. It is written in Java, and has about 6 kLoC. | ||
|
||
----------------------------------------------------------------------------------------------- | ||
|
||
## **Summary of Contributions** | ||
|
||
### Code Contribution | ||
[RepoSense Link](https://nus-cs2113-ay2324s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&tabAuthor=DextheChik3n&tabRepo=AY2324S1-CS2113-T17-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false) | ||
|
||
### Enhancements implemented | ||
#### Feature | ||
* **Add Dish** <br> | ||
Function: To allow the user to add a dish with the price and its ingredients to the menu<br> | ||
* The most crucial feature in the application in order for all the other features to perform their functions, which had to handle many arguments such as the names, price and quantity. | ||
* **Exit** <br> | ||
Function: To exit from the application | ||
* Implemented the backend logic in the main class in order to detect the user entered the `bye` keyword in order to exit from the application which was important to allow the storage to text file functionality to work | ||
|
||
### Enhancement | ||
* Created the methods for reading and writing files in FileManager.java | ||
* Created the regex patterns for most of the command features <br> | ||
* Required effort in learning how to format the regex string in order to get the specific intended user inputs | ||
* Created a ParserException class to allow for the use of handling specific errors<br> | ||
e.g checking for repeated dish/ingredient name, invalid price type, missing arguments, etc. | ||
|
||
### Contributions to the UG | ||
* Added documentation for the features: "add dish" and "exit" application | ||
* Added "Quick Start", "Notes about command format" and "Known Issues" section | ||
|
||
### Contributions to the DG | ||
* Add implementation for "Add dish" feature | ||
* Add implementation for the Storage class | ||
|
||
### Contributions to team-based tasks | ||
* Setting up the GitHub team org/repo | ||
* Created the main `CafeCtrl` class and the basic data objects such as `Menu`, `Ingredient` and `Dish` | ||
* Maintaining a bit of Gradle file | ||
* Maintaining the issue tracker, specifically creating the tags and assigning issues to team members with Zi Yi | ||
* Managed releases v1.0, v2.0 | ||
* Approving and merging PRs | ||
|
||
### Review/mentoring contributions | ||
* Examples of PRs reviewed: | ||
[#98](https://github.com/AY2324S1-CS2113-T17-2/tp/pull/98), [#119](https://github.com/AY2324S1-CS2113-T17-2/tp/pull/119), [#190](https://github.com/AY2324S1-CS2113-T17-2/tp/pull/190) | ||
* Managed the project team discussions by providing a meeting outline | ||
![Screenshot of Project Outline 1](../images_PPP/dexter/project_discussion1.png)<br> | ||
![Screenshot of Project Outline 2](../images_PPP/dexter/project_discussion2.png)<br> | ||
* Provided a summary of the division of labour after meetings | ||
![Notion Screenshot](../images_PPP/dexter/division_of_labour1.png)<br> | ||
![Telegram Screenshot](../images_PPP/dexter/division_of_labour.png)<br> | ||
|
||
### Contributions beyond the project team | ||
Reported bugs and suggestions for other teams in the class <br> | ||
(example: [#19](https://github.com/nus-cs2113-AY2324S1/tp/pull/19)) |
Binary file not shown.
This file was deleted.
Oops, something went wrong.