[CS2113-W12-1] Upcycle by winston-lim · Pull Request #3 · nus-cs2113-AY2223S1/tp

winston-lim · 2022-09-28T04:19:33Z

Value proposition

Upcycle is a service for students staying in a particular community(hall) to view, lease or borrow items that they wish to share to their community to promote frugality and sustainability.

Target users

Singaporeans -> Students -> University -> Staying in Campus -> Have items to lease or want to loan

Updated AboutUs

GitPancaked · 2022-10-26T03:12:52Z

+
+## 5. Product scope
+
+### 5.1. Target user profile


The target user profile is specified clearly. Great!

GitPancaked · 2022-10-26T03:13:44Z

+# Upcycle - Developer Guide
+
+## Table of contents
+[Acknowledgements](#acknowledgements)


I like the use of hyperlinks in the table of contents!

GitPancaked · 2022-10-26T03:31:17Z

+
+Given below is an example usage scenario and how the command mechanism behaves at each step.
+
+Step 1: The user types in the command in the command line. The CommandParser class checks if the command is valid through the createCommand() method, and either sends an exception, or send the input to the AddUserCommand class to be processed.


I think using steps to explain all the commands is good

GitPancaked · 2022-10-26T03:31:33Z

+## 8. Instructions for manual testing

-## Instructions for manual testing
+...To be updated


Great work! Can't wait to see the final DG.

wangtingjia · 2022-10-26T05:24:13Z

+
+...To be updated
+
+## 2. Setup the environment


I like the clear setup guide

wangtingjia · 2022-10-26T05:27:28Z

+
+Step 6: Lastly, information about the updated transaction is printed to the user
+
+The following sequence diagram models the operation:


Would it be better to leave out the exception call details as they are repeated multiple times throughout the docs

wangtingjia · 2022-10-26T05:29:24Z

+Upcycle is a Database Management System that aims to promote frugality and sustainability by providing service for students
+staying in a particular community/hall to loan or borrow items they wish to share with their community.
+
+## 6. User Stories


I like the clear user stories

wangtingjia · 2022-10-26T05:32:50Z

+
+Given below is an example usage scenario and how the command mechanism behaves at each step.
+
+Step 1: The user types in the command in the command line. The CommandParser class checks if the command is valid through the createCommand() method, and either throws an exception, or forwards the input to `UpdateTransactionCommand` class to be processed.


Would it be better to separate out a sample usage scenario and the explanation on how the code works. It might be clearer to split the sample usage into 1 part and explanation together with a sequence diagram in another

Handle exception when files are edited

Edit Class Diagrams (remove notations)

Added find-item to UG

Enhance Storage

…into branch-bug-price-overflows

Limit price range

…h, category index,

Branch limit arg range

Zhai-Yuxin

Really good and detailed. May consider not including in the exception part in your diagrams

Zhai-Yuxin · 2022-10-27T09:48:54Z

+Step 4: Lastly, `executeCommand` returns false to indicate that this is a non-terminating command
+
+The following sequence diagram shows how the view user operation works:
+![ListUserSequence](images/ListUserSequence.png)


consider adding in an activation bar for UI

Added new methods for ViewUserDebt and to FindTransactionsByUser

Clean code

RiaVora · 2022-10-28T03:16:21Z


-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+This project is based on the skeleton code and documents of [SE-EDU AddressBook Level-3](https://se-education.org/addressbook-level3/)
+


Like that you specify who wrote what under each section!

RiaVora · 2022-10-28T03:17:33Z

+
+**Step 4**: Go to File > Open, locate and open the cloned repository.
+
+**Step 5**: Verify the setup:


It might be better to name the running class differently than the iP? (change Duke to Upcycle)!

RiaVora · 2022-10-28T03:22:40Z

+## 3. Design
+
+This sector describes the architecture design of Upcycle with its components, and UML diagrams are used to support.
+


This isn't updated here, but is visible on the developer guide page: https://ay2223s1-cs2113-w12-2.github.io/tp/DeveloperGuide.html

For "The section below gives more detailed description of each component," I believe you forgot to move it to a new line underneath the image!

RiaVora · 2022-10-28T03:25:50Z

+Upcycle stores the user's data, including the user list, item list, transaction list in three files ```user.txt```, ```item.txt```, ```transaction.txt```, respectively.
+The data will be loaded when running the program, and ONLY be written to the files when exiting the program correctly, otherwise, the data during the execution will be gone.
+These find can be found in ```data``` folder in the same directory with the folder containing project root.
+


On the website: https://ay2223s1-cs2113-w12-2.github.io/tp/DeveloperGuide.html
there is an empty subsection!

ChengYoghurt · 2022-10-28T03:20:18Z

+and transactions via Command Line Interface with a single line of command.

 Useful links:
 * [User Guide](UserGuide.md)


Activation box ought to not immediately be closed, should leave some time for clearing the object up

ChengYoghurt · 2022-10-28T03:28:44Z

+and transactions via Command Line Interface with a single line of command.

 Useful links:
 * [User Guide](UserGuide.md)


Hello, may I ask why here use <>? Maybe yall trying to express <>

ChengYoghurt · 2022-10-28T03:34:25Z

+and transactions via Command Line Interface with a single line of command.

 Useful links:
 * [User Guide](UserGuide.md)


Here abt the input, it's a bit confusing for me.
Sine when reading a input, the control alrd should be passed to Ui and later return it.

For the second input, it never returns any control

ChengYoghurt · 2022-10-28T03:41:44Z

+and transactions via Command Line Interface with a single line of command.

 Useful links:
 * [User Guide](UserGuide.md)


Hi this 0 can be omitted~ But it's optional just want u to know

ChengYoghurt · 2022-10-28T03:45:38Z

+and transactions via Command Line Interface with a single line of command.

 Useful links:
 * [User Guide](UserGuide.md)


This new User() constructor box should end after the constructor returns

ChengYoghurt · 2022-10-28T03:46:38Z

+and transactions via Command Line Interface with a single line of command.

 Useful links:
 * [User Guide](UserGuide.md)


Oh I think the addUser() func never returns qwq

ChengYoghurt · 2022-10-28T03:50:15Z

+and transactions via Command Line Interface with a single line of command.

 Useful links:
 * [User Guide](UserGuide.md)


Ohhhhh this activation bar is half in the alt part

ChengYoghurt · 2022-10-28T03:53:07Z

+and transactions via Command Line Interface with a single line of command.

 Useful links:
 * [User Guide](UserGuide.md)


Ohhhhh not return again leh

Fix UG

UG DG

fix typo

Final commit

redders7 referenced this pull request in AY2223S1-CS2113-T18-1b/tp Oct 18, 2022

Merge pull request #3 from redders7/shaoYong-AboutUs

071bbe6

Updated AboutUs

GitPancaked reviewed Oct 26, 2022

View reviewed changes

wangtingjia reviewed Oct 26, 2022

View reviewed changes

bdthanh and others added 13 commits October 26, 2022 15:16

Merge pull request #130 from bdthanh/branch-storage-illegally-modified

2acce21

Handle exception when files are edited

Merge pull request #129 from bdthanh/branch-edit-dg

59db884

Edit Class Diagrams (remove notations)

Added find-item to UG

89d8b5d

Merge pull request #131 from jorellesee/master

8fe9555

Added find-item to UG

Fix bugs

91f8c93

Merge pull request #132 from bdthanh/branch-storage-illegally-modified

9e76a25

Enhance Storage

Fix bug when price > 99999999999 (limit range 0-10000)

63b9669

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-1/tp …

371aa56

…into branch-bug-price-overflows

Update UG

e04b993

Merge pull request #133 from bdthanh/branch-bug-price-overflows

21b20d0

Limit price range

Limit range of price, duration, createdDate, itemname, username lengt…

e000ba7

…h, category index,

Fix checkstyle

b654ecf

Merge pull request #134 from bdthanh/branch-limit-arg-range

d32adbd

Branch limit arg range

Zhai-Yuxin reviewed Oct 27, 2022

View reviewed changes

jingwei55 and others added 8 commits October 27, 2022 22:40

Update UserGuide.md

cabc4e4

Added new methods for ViewUserDebt and to FindTransactionsByUser

55b9198

Merge pull request #135 from jorellesee/master

3f74674

Added new methods for ViewUserDebt and to FindTransactionsByUser

Clean code

63c56f9

Fix UG

c57e4f3

Merge pull request #136 from bdthanh/branch-clean

bc40258

Clean code

Update DG

826e698

Update TransactionClassDiagram

9305f65

RiaVora reviewed Oct 28, 2022

View reviewed changes

ChengYoghurt reviewed Oct 28, 2022

View reviewed changes

chiewyx and others added 3 commits October 28, 2022 23:49

added more JUnit tests for User and UserList class

f20cf03

added more javadoc for user and userlist class

4eaaaa1

Fix UG typo and grammars and bug in add-tx command

f1e8698

bdthanh and others added 30 commits November 6, 2022 20:40

UpdateUG

42a31df

Fix FAQ numbering

a44656b

UG

7ff88e6

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-1/tp

e240ef8

Merge pull request #254 from bdthanh/master

672c225

Fix UG

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-1/tp

43ad926

Fix UG DG

e5a9c86

Fix bugs

5cc22b4

Improve message

bce0879

RepoSense

f23792c

Fix bdthanh image

0696990

Merge pull request #255 from bdthanh/master

a784526

UG DG

fix typo

176eeda

fix typo

63a4eee

Merge pull request #256 from jingwei55/master

f566439

fix typo

Polish UG DG

1ef19c2

Minor change in DG

c8478a8

Update jorelle.md

9a49f69

uploaded jorelle_image

d63c18f

Update AboutUs.md

53ec2c8

Rename jorelle.md to jorellesee.md

fc01cbe

Update AboutUs.md

a793998

Update jingwei55.md

7647aae

add jw image

cd8bbb8

Delete Jing Wei_Chien (2).jpg

b8aab96

Add files via upload

52fafac

Update AboutUs.md

289fb14

Reformat table (make it 600 commits ^^)

d477960

Final commit

a467abe

Merge pull request #257 from bdthanh/master

87f9e3e

Final commit


		Given below is an example usage scenario and how the command mechanism behaves at each step.

		Step 1: The user types in the command in the command line. The CommandParser class checks if the command is valid through the createCommand() method, and either sends an exception, or send the input to the AddUserCommand class to be processed.


		Step 6: Lastly, information about the updated transaction is printed to the user

		The following sequence diagram models the operation:


		{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
		This project is based on the skeleton code and documents of [SE-EDU AddressBook Level-3](https://se-education.org/addressbook-level3/)


		Step 4: Go to File > Open, locate and open the cloned repository.

		Step 5: Verify the setup:

		## 3. Design

		This sector describes the architecture design of Upcycle with its components, and UML diagrams are used to support.

Conversation

winston-lim commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Value proposition

Target users

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Zhai-Yuxin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

winston-lim commented Sep 28, 2022 •

edited

Loading