Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v1.4][T11-B4] TravelBanker #55

Open
wants to merge 152 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 52 commits
Commits
Show all changes
152 commits
Select commit Hold shift + click to select a range
2b5aa27
Add NFRs
Mar 7, 2018
a29a8c3
Merge pull request #1 from pkuhanan/add-NFRs
Mar 7, 2018
c78ccd6
create a removeTagCommand class to mimic EditCommand
chenchongsong Mar 7, 2018
6cbe3ec
modify the newly added RemoveTagCommand
chenchongsong Mar 7, 2018
19406f3
Merge pull request #2 from chenchongsong/ccs
chenchongsong Mar 7, 2018
5583f44
Revert "Chen Chongsong Enhancement"
chenchongsong Mar 7, 2018
98184c6
Merge pull request #3 from CS2103JAN2018-T11-B4/revert-2-ccs
chenchongsong Mar 7, 2018
6cf215a
Allowed program to recognize h alias as help command
articho28 Mar 7, 2018
370034c
hi is now shortcut for History Command
articho28 Mar 7, 2018
169e1ea
c is now a shortcut for Clear command
articho28 Mar 7, 2018
d1e89de
l is now shortcut for list command
articho28 Mar 7, 2018
acd295c
u is shortcut for Undo and r is shortcut for Redo
articho28 Mar 7, 2018
3beb42a
a is shortcut for add
articho28 Mar 7, 2018
06dbf2f
d is shorcut for delete
articho28 Mar 7, 2018
424275a
e is now shortcut for edit
articho28 Mar 7, 2018
3634375
f is now shortcut for find
articho28 Mar 7, 2018
94509bf
s is now shortcut for Select
articho28 Mar 7, 2018
8fb756b
Updated User Guide to include shortcuts
articho28 Mar 7, 2018
3eb8d87
Added JUnit test for help shortcut
articho28 Mar 7, 2018
7e82e88
Added test for list shortcut
articho28 Mar 7, 2018
dd12262
Added test for clear command shortcut
articho28 Mar 7, 2018
eb95f6e
Added test for history shortcut
articho28 Mar 7, 2018
957f919
Added tests for find, edit, and delete shortcuts
articho28 Mar 7, 2018
18e53c4
Added tests for redo, undo, select shortcuts
articho28 Mar 7, 2018
6f90b27
Added test for add command shortcut
articho28 Mar 7, 2018
3026364
Updated Target user profile, value proposition, and user stories
articho28 Mar 7, 2018
94db81b
Fixed formatting issues in Developper Guide
articho28 Mar 13, 2018
c5ed3ab
Remove Codacy badge
Mar 13, 2018
62e5b07
Style errors (#10)
Mar 13, 2018
ad3b9ed
fix user story format
chenchongsong Mar 14, 2018
5313f1b
update use cases
chenchongsong Mar 14, 2018
87ab44e
Merge pull request #1 from CS2103JAN2018-T11-B4/master
chenchongsong Mar 14, 2018
5063e9e
User and Developer Guide Update including instructions on the balance…
articho28 Mar 15, 2018
32afd24
Update UserGuide.adoc (#22)
Mar 15, 2018
e2fa60c
Add money field and add/edit capability (#28)
Mar 16, 2018
ccf9e5e
merge Master2 into Master (#29)
chenchongsong Mar 16, 2018
0b02a3f
Merge pull request #4 from CS2103JAN2018-T11-B4/master
chenchongsong Mar 17, 2018
210c3f2
Remove tag feature enabled (#30)
chenchongsong Mar 18, 2018
8f6475d
Merge pull request #5 from CS2103JAN2018-T11-B4/master
chenchongsong Mar 18, 2018
496b128
SortCommand Init (mimic listCommand)
chenchongsong Mar 18, 2018
493ecc8
Merge pull request #6 from chenchongsong/master
chenchongsong Mar 18, 2018
c82b0ad
commit parser init
chenchongsong Mar 18, 2018
1545040
Feature Contribution for Developer Guide + Modified Documentation Fol…
articho28 Mar 19, 2018
77c75ec
Update UserGuide Appendix B [Feature Contribution] (#34)
chenchongsong Mar 19, 2018
b37884d
updated developer guide with balance (#35)
software-1234 Mar 19, 2018
ca7ebd9
About us update (#25)
software-1234 Mar 20, 2018
1beb23c
Add feature info to developer guide (#36)
Mar 20, 2018
d371e1b
Update AboutUs.adoc (#37)
software-1234 Mar 20, 2018
3ec8c53
Update my minor feature (#41)
Mar 20, 2018
8655f15
Add command biggest-debtor (#42)
Mar 20, 2018
d60a99f
Rename biggest-debtor to max (#43)
Mar 20, 2018
d78e1cf
Add 1 page of documentation for add/edit money field feature (#45)
Mar 20, 2018
7ca66ad
sort command enabled for name filed
chenchongsong Mar 20, 2018
b42c92b
Balance feature documentation, source code, and tests included. (#33)
articho28 Mar 20, 2018
7787f00
resolve conflicts
chenchongsong Mar 20, 2018
34f0149
Merge pull request #8 from CS2103JAN2018-T11-B4/master
chenchongsong Mar 20, 2018
cf2576c
update method prototypes for future use
chenchongsong Mar 20, 2018
180d9c8
Min feature - Source Code and Documentation (#47)
articho28 Mar 20, 2018
7a038db
remove BiggestDebtor (#50)
Mar 20, 2018
5edb4a6
Min Feature Updated - Corrected to not select anyone if no money is o…
articho28 Mar 20, 2018
50a7d1c
sorting keyword: email, phone, money, address enabled
chenchongsong Mar 21, 2018
2e5718f
update compareTo methods for various class
chenchongsong Mar 21, 2018
35182f6
sorting enabled for no_of_tags
chenchongsong Mar 21, 2018
89a7fe6
Merge branch 'master' into sort-feature
chenchongsong Mar 21, 2018
515c4ad
fix travis
chenchongsong Mar 21, 2018
de81ead
Merge branch 'sort-feature' of https://github.com/chenchongsong/main …
chenchongsong Mar 21, 2018
422ab63
fix test part for travis
chenchongsong Mar 21, 2018
e97cb3f
update userGuide.adoc
chenchongsong Mar 21, 2018
6929a9a
Sort feature (#51)
chenchongsong Mar 21, 2018
4eff081
Merge pull request #10 from chenchongsong/sort-feature
chenchongsong Mar 21, 2018
f9c5f91
Merge pull request #9 from CS2103JAN2018-T11-B4/master
chenchongsong Mar 21, 2018
9122b22
Sort implementation documentation (Chen Chongsong) (#53)
chenchongsong Mar 21, 2018
65e4b34
Eric list developer guide (#55)
software-1234 Mar 21, 2018
4c4740c
listing balances (#54)
software-1234 Mar 21, 2018
f409383
Update DeveloperGuide.adoc (#56)
Mar 27, 2018
eb3d8f8
Add settle command (#57)
Mar 27, 2018
74dc47e
Add files via upload (#59)
Mar 27, 2018
758859e
Merge pull request #11 from CS2103JAN2018-T11-B4/master
chenchongsong Mar 28, 2018
59eaf42
V1.3 split feature (#68)
chenchongsong Mar 28, 2018
e427295
change command word and shortcut (#71)
software-1234 Mar 28, 2018
cf06497
Merging MapCommand : Loads a search for nearest ATM (#72)
articho28 Mar 28, 2018
e89d4b8
Updated UIMockup in ReadMe.adoc (#73)
articho28 Mar 28, 2018
0176961
added wipe balance (#76)
software-1234 Mar 28, 2018
0e8cf84
ran /gradle shadowJar (#78)
articho28 Mar 29, 2018
a1d60dc
Modified version number in main - Added tag v1.3 to release (#79)
articho28 Mar 29, 2018
f8cf337
Merge pull request #12 from CS2103JAN2018-T11-B4/master
chenchongsong Mar 29, 2018
35f547e
update userguide image
chenchongsong Mar 29, 2018
cd2e4a5
update img (#80)
chenchongsong Mar 29, 2018
beb213c
Item feature Init (#83)
chenchongsong Mar 31, 2018
6c01c92
Merge remote-tracking branch 'upstream/master'
chenchongsong Mar 31, 2018
4746d14
Build the remind command feature (#81)
Apr 1, 2018
9b26e79
Itemadd command (#87)
chenchongsong Apr 1, 2018
e398c5c
Merge remote-tracking branch 'upstream/master'
chenchongsong Apr 1, 2018
24f6016
add collate comments //@@author chenchongsong
chenchongsong Apr 1, 2018
0f4972a
add collated *.md files
chenchongsong Apr 1, 2018
57db803
update documentation for major enhancement and ItemAddCommand
chenchongsong Apr 1, 2018
9cf69b7
travis
chenchongsong Apr 1, 2018
6068030
Update user guide with currency and wipe
software-1234 Apr 2, 2018
9d2b668
Update UserGuide.adoc (#92)
software-1234 Apr 2, 2018
35b2950
started currency conversion for specific addressbook entries (#93)
software-1234 Apr 2, 2018
4579065
Merge branch 'master' into master
chenchongsong Apr 2, 2018
dd71c2c
Collate (#86)
Apr 3, 2018
bc694d4
Merge branch 'master' into master
chenchongsong Apr 3, 2018
86b1f96
Collate and update Documentation (#89)
chenchongsong Apr 3, 2018
d4d95e1
Currency converter (#95)
software-1234 Apr 4, 2018
51554b8
Select feature now searches for Address (#96)
articho28 Apr 4, 2018
0ed851b
Finalized v1.4 (#98)
articho28 Apr 4, 2018
c57b85e
Merge branch 'master' into master
chenchongsong Apr 6, 2018
e66475e
ItemDeleteCommand and update ItemShowCommand (#106)
chenchongsong Apr 7, 2018
f35ce80
update documentation and collate for v1.5rc (#108)
chenchongsong Apr 8, 2018
79369d6
Create .overalls.yml
chenchongsong Apr 8, 2018
e0cf3d8
Add PPP (#144)
Apr 10, 2018
1e29220
Remove biggest debtor and add collate (#145)
Apr 11, 2018
69f088c
add more JUnit tests (#141)
chenchongsong Apr 11, 2018
237856f
Create transaction command (#143)
Apr 11, 2018
9bac11f
Collated Code with SearchTagCommand, documentation and tests (#146)
articho28 Apr 11, 2018
d581751
Update UserGuide.adoc (#151)
software-1234 Apr 11, 2018
aeb3ae7
Update DeveloperGuide.adoc (#154)
software-1234 Apr 11, 2018
0016a4e
Update DeveloperGuide.adoc
software-1234 Apr 11, 2018
285a7b2
software-1234-ppp (#155)
software-1234 Apr 11, 2018
3a66888
Update software-1234.adoc
software-1234 Apr 11, 2018
285eebc
Update software-1234.adoc
software-1234 Apr 11, 2018
ff3b02e
Currency changes (#150)
software-1234 Apr 11, 2018
9522748
Wipe undo (#159)
software-1234 Apr 12, 2018
a86faef
update doc and bug fixing (#162)
chenchongsong Apr 12, 2018
9e1037a
Add Balance label and fix remind command usage instructions (#160)
Apr 12, 2018
5906165
update docs and fix bugs (#163)
chenchongsong Apr 12, 2018
59c6796
Add some tests (#164)
Apr 12, 2018
2490719
Fix ppp (#165)
Apr 12, 2018
6f26e8c
add tests for itemshowcommand parser and itemdeletecommandparser (#166)
chenchongsong Apr 14, 2018
bdb4b37
add 2 tests (#167)
chenchongsong Apr 14, 2018
7185f13
Update README.adoc
chenchongsong Apr 14, 2018
ba43f98
Added tests for maxborrowed command (MinCommand in code) (#168)
articho28 Apr 14, 2018
e087ae5
Modified portofolio, about us, and formatting (#169)
articho28 Apr 14, 2018
2a301e0
Update collated (#170)
Apr 14, 2018
1b677d9
Documentation modification, updated collation and added tests (#171)
articho28 Apr 14, 2018
13cd602
Update README.adoc
articho28 Apr 14, 2018
d88fbbd
change mockup (#172)
articho28 Apr 14, 2018
a47215f
Update UserGuide.adoc
articho28 Apr 14, 2018
09ccb3b
Update README.adoc
articho28 Apr 14, 2018
573f21d
Update README.adoc
chenchongsong Apr 14, 2018
9845422
Addressed all Issues reported in peer-testing to resubmit (#173)
articho28 Apr 15, 2018
b8e0ff9
Fixed collation of my code (#174)
articho28 Apr 15, 2018
a84486e
added Tests for list balances (#175)
software-1234 Apr 15, 2018
7b543c5
Update UserGuide.adoc (#176)
software-1234 Apr 15, 2018
38aa55c
Update README.adoc
chenchongsong Apr 15, 2018
b995b9d
Add files via upload
software-1234 Apr 15, 2018
114049a
Update UserGuide.adoc
software-1234 Apr 15, 2018
2c879e0
add files
software-1234 Apr 15, 2018
5f4a5c5
Update UserGuide.adoc
software-1234 Apr 15, 2018
c298021
Update DeveloperGuide.adoc (#178)
software-1234 Apr 15, 2018
977276c
Update software-1234.adoc (#177)
software-1234 Apr 15, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
= Address Book (Level 4)
= TravelBanker
ifdef::env-github,env-browser[:relfileprefix: docs/]

https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should update all badges.


ifdef::env-github[]
Expand All @@ -15,26 +14,44 @@ ifndef::env-github[]
image::images/Ui.png[width="600"]
endif::[]

* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
** A more sophisticated GUI that includes a list panel and an in-built Browser.
** More test cases, including automated GUI testing.
** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
== Introduction

* This is a desktop java application that helps people, particularly travellers, to informally keep accounts with other people.
* Record how much money you owe someone, or someone owes to you, plus much more!
* Most of your user interactions are via command line, while there exists a GUI (Graphical User Interface).

== Getting Started
For developers, please refer to the "DeveloperGuide.adoc" under "Section 1. Setting Up"
and ensure the steps are properly followed.

For users, please refer to the "UserGuide.adoc" for instructions on how to
use the application.

Below is a list of useful links to the relevant documents to get you started.

== Site Map

* <<UserGuide#, User Guide>>
* <<DeveloperGuide#, Developer Guide>>
* <<LearningOutcomes#, Learning Outcomes>>
* <<AboutUs#, About Us>>
* <<ContactUs#, Contact Us>>


== Built With
- IntelliJ IDE - Software Development
- GitHub - Source Control

== Authors (in Alphabetical Order)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should be found in AboutUs.

- Artsiom Skliar - Developer
- Chen Chongsong - Developer
- Eric Lingfeng Zhou - Developer
- Prian Kuhanandan - Developer

== Acknowledgements

* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
_Marco Jakob_.
* Libraries used: https://github.com/TomasMikula/EasyBind[EasyBind], https://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit4[JUnit4]
* Source code is based on the https://github.com/se-edu/addressbook-level4[AddressBook-Level4] project created by SE-EDU initiative.

== Licence : link:LICENSE[MIT]
50 changes: 20 additions & 30 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,53 +3,43 @@
:imagesDir: images
:stylesDir: stylesheets

AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
{empty} +
TravelBanker - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. + {empty} +
We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].

== Project Team

=== John Doe
image::damithc.jpg[width="150", align="left"]
{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
=== Arty Skillar
image::Articho28.jpg[width="150", align="left"]
{empty}[https://github.com/Articho28[github]] [<<johndoe#, portfolio>>]

Role: Project Advisor
Role: Team Lead + Deliverables and Deadlines

'''

=== John Roe
image::lejolly.jpg[width="150", align="left"]
{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
=== Prian Kudahan
image::pkunahan.jpg[width="150", align="left"]
{empty}[http://github.com/pkunahan[github]] [<<johndoe#, portfolio>>]

Role: Team Lead +
Responsibilities: UI
Role: Testing

'''

=== Johnny Doe
image::yijinl.jpg[width="150", align="left"]
{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]

Role: Developer +
Responsibilities: Data

'''

=== Johnny Roe
image::m133225.jpg[width="150", align="left"]
{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
=== Chen Chongsong
image::chenchongsong.jpg[width="150", align="left"]
{empty}[http://github.com/chenchongsong[github]] [<<johndoe#, portfolio>>]

Role: Code Quality

Role: Developer +
Responsibilities: Dev Ops + Threading

'''

=== Benson Meier
image::yl_coder.jpg[width="150", align="left"]
{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
=== Eric Zhou
image::software-1234.jpg[width="150", align="left"]
{empty}[http://github.com/software-1234[github]] [<<johndoe#, portfolio>>]

Role: Documentation

Role: Developer +
Responsibilities: UI

'''

Loading