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

[CS2103T-W16-2] ZeroToOne #11

Open
wants to merge 870 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
870 commits
Select commit Hold shift + click to select a range
02770cb
add check for onlyPrefixesPresent
alloystory Apr 11, 2020
c34dad3
Update tests for workout exercises
chishanw Apr 11, 2020
8c7784b
Merge branch 'master' into branch-workout
chishanw Apr 11, 2020
a95731b
add check for repeated prefixes
alloystory Apr 11, 2020
f22417b
edit code errors
alloystory Apr 11, 2020
402be38
fix argument tokenizer test
alloystory Apr 11, 2020
cdf4576
Merge branch 'master' into add-test
chishanw Apr 11, 2020
51039c8
Merge pull request #215 from jiachen247/add-test
chishanw Apr 11, 2020
8eeb1b1
Merge branch 'master' into feature-schedule
chishanw Apr 11, 2020
22a1ee1
Merge pull request #221 from Guofeng-Tang/feature-schedule
chishanw Apr 11, 2020
a056ce8
Merge branch 'master' into update-log-ug
chishanw Apr 11, 2020
8d0ed7e
Merge pull request #222 from jiachen247/update-log-ug
chishanw Apr 11, 2020
d3fdc59
Merge branch 'master' into set-focus
chishanw Apr 11, 2020
4be9018
add tokenize(String) method
alloystory Apr 11, 2020
e2b8345
Merge pull request #223 from jiachen247/set-focus
chishanw Apr 11, 2020
54636d9
Merge branch 'master' into branch-workout
chishanw Apr 11, 2020
eff093a
replace all parsers with new tokenize method
alloystory Apr 11, 2020
9916be0
fix infinite loop
alloystory Apr 11, 2020
1d9c5cd
remove debug line
alloystory Apr 11, 2020
89522e2
edit unknown command messages
alloystory Apr 11, 2020
ae20576
Merge branch 'branch-fix-bugs-2'
alloystory Apr 11, 2020
04bece7
Merge pull request #224 from chishanw/branch-workout
alloystory Apr 11, 2020
77b65c8
Merge branch 'master' into master
alloystory Apr 11, 2020
3b01a62
Add example screenshot
Apr 12, 2020
b8664ae
Edit about and exit sections
chishanw Apr 12, 2020
e1eede7
Merge pull request #225 from alloystory/master
chishanw Apr 12, 2020
50f5fce
Update DoneCommand sequence diagram
Apr 12, 2020
92b1b24
refactor ui package
alloystory Apr 12, 2020
344c4b0
add MainClassDiagarm
alloystory Apr 12, 2020
b621269
add Main component description
alloystory Apr 12, 2020
64875f6
edit UiClassDiagram
alloystory Apr 12, 2020
2f60b5c
edit MainClassDiagram
alloystory Apr 12, 2020
788b4ab
make parsers extend from Parser interface
alloystory Apr 12, 2020
b75ac90
make commands extend from parent command
alloystory Apr 12, 2020
8960842
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/ma…
Apr 12, 2020
d85d2e3
Update PPP
Apr 12, 2020
8b5a1e0
Add more to PPP
Apr 12, 2020
df18af4
edit LogicClassDiagram
alloystory Apr 12, 2020
8d61e45
Add PauseTransition upon Exit to let user see exit message (#226)
chishanw Apr 12, 2020
6efee4a
delete recurring create command from about page
Guofeng-Tang Apr 12, 2020
81393d1
edit DeleteSequenceDiagram
alloystory Apr 12, 2020
8fbdf20
Merge branch 'master' into update-adocs
gb3h Apr 12, 2020
61cf94e
edit ModelClassDiagram
alloystory Apr 12, 2020
70cc1e8
edit StorageClassDiagram
alloystory Apr 12, 2020
f6747ce
edit grammatical error
alloystory Apr 12, 2020
60df66b
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/main
alloystory Apr 12, 2020
c29a52a
Merge pull request #227 from gb3h/update-adocs
alloystory Apr 12, 2020
c516b90
Merge branch 'master' into master
alloystory Apr 12, 2020
2374ba0
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/main
alloystory Apr 12, 2020
29c2daf
Merge branches 'master' and 'master' of https://github.com/alloystory…
alloystory Apr 12, 2020
b52b2ce
abstract Models into respective package models
alloystory Apr 12, 2020
6cb0e43
abstract Logic
alloystory Apr 12, 2020
43c449c
abstract Storage
alloystory Apr 12, 2020
f81df7d
edit Logic, Model and Storage Class Diagrams
alloystory Apr 12, 2020
61b6ad2
add statistics OOP
jiachen247 Apr 12, 2020
79dcc9d
restore ui for schedule datetime
Guofeng-Tang Apr 12, 2020
9773cff
update UG and its schedule section screenshots
Guofeng-Tang Apr 12, 2020
c8e0bf7
add statistics OOP (#229)
jiachen247 Apr 12, 2020
91096dd
add tags in UG
Guofeng-Tang Apr 12, 2020
4ba3380
Update docs
chishanw Apr 12, 2020
fef4b97
Merge remote-tracking branch 'origin/master' into branch-user-guide
chishanw Apr 12, 2020
1ebbb3e
fix checkstyle errors
alloystory Apr 12, 2020
d1a507e
add checks to hooks
alloystory Apr 12, 2020
f982bac
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/main
alloystory Apr 12, 2020
3ed16fe
fix checkstyle error
alloystory Apr 12, 2020
0789e7b
edit pre-push hooks
alloystory Apr 12, 2020
0e2442a
Merge pull request #228 from alloystory/master
chishanw Apr 12, 2020
26b4376
Update sequence diagram
chishanw Apr 12, 2020
5f74a28
change order of sections in UG
Guofeng-Tang Apr 12, 2020
e1c0b20
Merge remote-tracking branch 'origin/master' into branch-user-guide
chishanw Apr 12, 2020
ff7a9e9
edit DeleteSequenceDiagram
alloystory Apr 12, 2020
1b1f4c4
add CreateCommandSequenceDiagram
alloystory Apr 12, 2020
4a29fef
add ExerciseModelClassDiagram
alloystory Apr 12, 2020
78b4304
add other Exercise UML Diagrams
alloystory Apr 12, 2020
cc38e63
edit Exercise DG
alloystory Apr 12, 2020
c19b7b2
add EditSetActivityDiagram
alloystory Apr 12, 2020
b889f1a
edit Exercise DG
alloystory Apr 12, 2020
a6b984a
organize team-pics
alloystory Apr 12, 2020
0b5cb5b
organize userguide-screenshots
alloystory Apr 12, 2020
34c29f1
organise images
alloystory Apr 12, 2020
c95427e
organize diagrams
alloystory Apr 12, 2020
f5e6117
edit DG
alloystory Apr 12, 2020
0d13066
edit user-guide folder
alloystory Apr 12, 2020
939c272
minor edits
alloystory Apr 12, 2020
64089f5
add more stuff in DG
Guofeng-Tang Apr 12, 2020
1194b77
Edit Docs (#232)
alloystory Apr 12, 2020
00a496b
Merge branch 'feature-schedule'
Guofeng-Tang Apr 12, 2020
dfa6a7b
move ug dg images
Guofeng-Tang Apr 12, 2020
bef7753
add PPP
Guofeng-Tang Apr 13, 2020
ef74334
fix image paths so that PPP don't break
Guofeng-Tang Apr 13, 2020
30704f4
add Javadoc
Guofeng-Tang Apr 13, 2020
05f1de8
add regression test
jiachen247 Apr 13, 2020
02d7562
Merge remote-tracking branch 'upstream/master' into add-test
jiachen247 Apr 13, 2020
48ef5d7
Merge pull request #233 from Guofeng-Tang/master
alloystory Apr 13, 2020
f7d96c0
Merge branch 'master' into feature-schedule
alloystory Apr 13, 2020
ce98a9b
Merge pull request #234 from Guofeng-Tang/feature-schedule
alloystory Apr 13, 2020
12b0e9d
Merge branch 'master' into javadoc
alloystory Apr 13, 2020
6e89591
add basic logging to log commands
jiachen247 Apr 13, 2020
fbe532b
Merge pull request #235 from Guofeng-Tang/javadoc
alloystory Apr 13, 2020
e87a3ac
Merge branch 'master' into add-test
alloystory Apr 13, 2020
06f0056
Edit Model Component section of DF
Apr 13, 2020
a2bb929
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/main
Apr 13, 2020
208a5d7
Merge pull request #231 from jiachen247/add-test
alloystory Apr 13, 2020
b627808
Merge branch 'master' into add-logging
jiachen247 Apr 13, 2020
bf443a0
Merge pull request #236 from jiachen247/add-logging
alloystory Apr 13, 2020
598fc0c
Edit DG
chishanw Apr 13, 2020
4c34bc4
Update model component diagram to include relevant session models
Apr 13, 2020
f3174e6
Merge remote-tracking branch 'origin/master' into branch-user-guide
chishanw Apr 13, 2020
da4e7e1
Update model component in the DG
Apr 13, 2020
3a1fb37
Standadize sample data across tabs
jiachen247 Apr 13, 2020
edfabf0
Standardaise colon
Apr 13, 2020
eaf0939
fix complete set bug
jiachen247 Apr 13, 2020
ce2ecac
Update activity diagram
Apr 13, 2020
a1e86d5
fix css path
jiachen247 Apr 13, 2020
b4bd25a
improve fake log data
jiachen247 Apr 13, 2020
01d1680
update about page with log commands
jiachen247 Apr 13, 2020
f4ca959
Add session model class diagram
Apr 13, 2020
14d2f59
Add class diagram to DG
Apr 13, 2020
8c50a6d
Add tags and touch up PPP
Apr 13, 2020
bb0ad4e
Update PPP
Apr 13, 2020
e93c698
Add logging to StartCommand
Apr 13, 2020
ca2966d
Change version to correct version
Apr 13, 2020
20dc1cd
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/main
alloystory Apr 13, 2020
4ae3e36
Add logging to SkipCommand
Apr 13, 2020
85da536
Add logging to DoneCommand
Apr 13, 2020
60db0a7
Add logging to StopCommand
Apr 13, 2020
b8ec3fb
Make copy of old screenshots
Apr 13, 2020
18b37e7
Update DG and revamp UML diagrams
chishanw Apr 13, 2020
5b2b060
Update slight styling
chishanw Apr 13, 2020
079d4bd
Change all screenshots and edit some UG mistakes
Apr 13, 2020
5bb36dc
Merge branch 'master' into sync-sample-data
gb3h Apr 13, 2020
1b7165e
Merge pull request #237 from jiachen247/sync-sample-data
gb3h Apr 13, 2020
bbe026a
Merge branch 'master' into final-documentation-changes
gb3h Apr 13, 2020
317bf60
Merge pull request #238 from gb3h/final-documentation-changes
chishanw Apr 13, 2020
7587031
Merge branch 'master' into add-logging
chishanw Apr 13, 2020
6b329fc
Merge pull request #239 from gb3h/add-logging
chishanw Apr 13, 2020
8385d27
Merge branch 'master' into branch-user-guide
chishanw Apr 13, 2020
2d97dcd
Merge pull request #240 from chishanw/branch-user-guide
chishanw Apr 13, 2020
83e24d5
Merge branch 'master' into ug-update-screenshots
chishanw Apr 13, 2020
24611b6
Merge pull request #241 from gb3h/ug-update-screenshots
chishanw Apr 13, 2020
40726bc
Fix UG screenshots
Apr 13, 2020
9bdb2a6
Update User Guide for Workout
chishanw Apr 13, 2020
1f7d294
Update User Guide for Workout
chishanw Apr 13, 2020
aa48e40
Add effort appendix in dg
Apr 13, 2020
e09f698
edit alloystory.adoc
alloystory Apr 13, 2020
ff67742
add exercise tag to UG
alloystory Apr 13, 2020
926f18a
Update user feedback msgs
chishanw Apr 13, 2020
41c5e50
Update workout edit command
chishanw Apr 13, 2020
cf35817
added tag to UserGuide and Developer Guide
alloystory Apr 13, 2020
b2ace55
Update UG for workout
chishanw Apr 13, 2020
366f225
add screenshots to team portfolio
alloystory Apr 13, 2020
6f1b16a
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/main
alloystory Apr 13, 2020
8d2cdad
Merge branch 'development'
alloystory Apr 13, 2020
d6bb135
Update proposed feature to v2.0 feature
chishanw Apr 13, 2020
a7957ab
Add effort appendix in dg
Apr 13, 2020
92b3504
Fix outdated schedule screenshot
Apr 13, 2020
390d697
Add screenshot to PPP
Apr 13, 2020
6b54b38
unorganize team-pics
alloystory Apr 13, 2020
52d31bc
Add link to section
Apr 13, 2020
650cb2a
Merge pull request #245 from alloystory/master
chishanw Apr 13, 2020
27ffc00
Merge branch 'master' into fix-screenshots
gb3h Apr 13, 2020
1d0c819
Merge remote-tracking branch 'origin/master' into branch-user-guide
chishanw Apr 13, 2020
8f4b1ce
Merge branch 'master' into dg-effort
alloystory Apr 13, 2020
236954c
Merge pull request #243 from gb3h/fix-screenshots
gb3h Apr 13, 2020
7b699e3
Merge branch 'master' into dg-effort
alloystory Apr 13, 2020
d6e26a7
Merge pull request #244 from gb3h/dg-effort
alloystory Apr 13, 2020
102d616
edit exercise card
alloystory Apr 13, 2020
a5ecd49
add developer guide
jiachen247 Apr 13, 2020
728dd16
merge master
jiachen247 Apr 13, 2020
65ac763
add logging to exercise classes
alloystory Apr 13, 2020
8846d6e
Merge pull request #246 from alloystory/master
gb3h Apr 13, 2020
b6db6aa
add logging to LogicManager
alloystory Apr 13, 2020
0a7318a
Merge branch 'master' into add-log-dg
jiachen247 Apr 13, 2020
4b06612
add logging to exercise commands
alloystory Apr 13, 2020
d7766a1
Documentation edits (#247)
gb3h Apr 13, 2020
3c90a68
Merge branch 'master' into add-log-dg
gb3h Apr 13, 2020
ed6353c
Merge pull request #248 from jiachen247/add-log-dg
gb3h Apr 13, 2020
7b52111
edited ModelManager
alloystory Apr 13, 2020
66aa90b
add developer guide
jiachen247 Apr 13, 2020
ed0d2e1
minor dg and ug update
jiachen247 Apr 13, 2020
6148dcc
add logging to Exercise Model
alloystory Apr 13, 2020
95861d0
add logging to StorageManager
alloystory Apr 13, 2020
708ca2e
simulate randomness in sample logs
jiachen247 Apr 13, 2020
c871fe0
add logging to exercise storage
alloystory Apr 13, 2020
278bb16
convert logger 'info' to 'fine'
alloystory Apr 13, 2020
4df2e26
Merge branch 'development'
alloystory Apr 13, 2020
c2d1949
Merge pull request #250 from jiachen247/minor-fix
gb3h Apr 13, 2020
1dc1cd9
Revert "add logging to exercise storage"
alloystory Apr 13, 2020
2a65c7b
Merge branch 'development'
alloystory Apr 13, 2020
ede2f74
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/main
alloystory Apr 13, 2020
c4c5d37
Update PPP
chishanw Apr 13, 2020
8f9b6c8
fix broken link in DG
jiachen247 Apr 13, 2020
506dbf6
Merge branch 'master' into branch-user-guide
chishanw Apr 13, 2020
72dbb16
Merge pull request #252 from alloystory/master
chishanw Apr 13, 2020
52ddc52
Update PPP
chishanw Apr 13, 2020
c1997ab
Merge branch 'branch-user-guide' of https://github.com/chishanw/main …
chishanw Apr 13, 2020
41713fc
Merge branch 'master' into branch-user-guide
chishanw Apr 13, 2020
0bd9fa0
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/ma…
jiachen247 Apr 13, 2020
f32d32c
Add start session testing guide
Apr 13, 2020
f2e6e87
Add save session testing guide
Apr 13, 2020
0a88d29
Add save session testing guide
Apr 13, 2020
29e0fe7
Add UML Diagrams adoc
Apr 13, 2020
46606bf
Add logging to Workout Parser classes
chishanw Apr 13, 2020
77c6533
Add UML Diagrams adoc
Apr 13, 2020
941d9cd
Merge pull request #253 from chishanw/branch-user-guide
alloystory Apr 13, 2020
03ade90
Merge branch 'master' into appendix
alloystory Apr 13, 2020
8f96dda
Add UML Diagram txt
Apr 13, 2020
127c477
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/ma…
Apr 13, 2020
f6d24a1
Merge branch 'appendix' of https://github.com/gb3h/main into appendix
Apr 13, 2020
a694ec9
Merge pull request #254 from gb3h/appendix
alloystory Apr 13, 2020
e829ce6
Logging for workout commands
chishanw Apr 13, 2020
5a9c561
Add logging to workout model
chishanw Apr 13, 2020
b72deab
add PPP
jiachen247 Apr 13, 2020
2dcb03e
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/ma…
jiachen247 Apr 13, 2020
3234482
update PPP
Guofeng-Tang Apr 13, 2020
4b464b9
rename scheduleList to scheduler
Guofeng-Tang Apr 13, 2020
e763a57
add basic logging for scheduler
Guofeng-Tang Apr 13, 2020
8b283d5
update PPP links
Guofeng-Tang Apr 13, 2020
8c728b1
add schedule activity diagram to DG
Guofeng-Tang Apr 13, 2020
a37dea8
add UML adoc
Guofeng-Tang Apr 13, 2020
8b451db
edit stuff (#256)
alloystory Apr 13, 2020
acf2615
Merge branch 'master' into master
Guofeng-Tang Apr 13, 2020
0e2d01e
fix stylesheets
Guofeng-Tang Apr 13, 2020
0e28815
Add logging for workouts (#257)
chishanw Apr 13, 2020
296d755
Merge branch 'master' into master
Guofeng-Tang Apr 13, 2020
6149668
update UG images
jiachen247 Apr 13, 2020
2df5fc9
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/main
chishanw Apr 13, 2020
54ed66b
Merge branch 'master' of https://github.com/chishanw/main
chishanw Apr 13, 2020
7b93729
Merge remote-tracking branch 'origin/master' into branch-workout
chishanw Apr 13, 2020
b55e77b
Create PPP for jiachen (#258)
jiachen247 Apr 13, 2020
dbf4fc3
Merge branch 'master' into master
Guofeng-Tang Apr 13, 2020
acda59b
Merge pull request #259 from Guofeng-Tang/master
alloystory Apr 13, 2020
ca9d742
fix minor bugs
jiachen247 Apr 13, 2020
2fa329b
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/ma…
jiachen247 Apr 13, 2020
22b9ef7
Merge branch 'master' into fix-last-minor-bugs
gb3h Apr 13, 2020
7f714f6
Fix bug for workout name parsing
chishanw Apr 13, 2020
bd26e10
Merge pull request #260 from jiachen247/fix-last-minor-bugs
alloystory Apr 13, 2020
a71fdc8
Fix workout name test
chishanw Apr 13, 2020
e036bca
Merge branch 'master' into branch-workout
chishanw Apr 13, 2020
166e0c8
fix minor bugs
jiachen247 Apr 13, 2020
ca6d15f
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/ma…
jiachen247 Apr 13, 2020
d0c501b
Merge pull request #261 from chishanw/branch-workout
gb3h Apr 13, 2020
28ab78b
Merge branch 'master' into fix-last-minor-bugs
gb3h Apr 13, 2020
b322af7
Merge pull request #262 from jiachen247/fix-last-minor-bugs
gb3h Apr 13, 2020
67f7f74
Add adoc header tags (#263)
gb3h Apr 13, 2020
344cadd
update full team names in about us
jiachen247 Apr 13, 2020
e749b34
Merge branch 'master' of https://github.com/AY1920S2-CS2103T-W16-2/ma…
jiachen247 Apr 13, 2020
c3a9f56
Merge pull request #264 from jiachen247/fix-last-minor-bugs
chishanw Apr 13, 2020
f1a7dac
rename PPP page filename to all lowercase
Guofeng-Tang Apr 16, 2020
b9fa5b7
Merge pull request #266 from Guofeng-Tang/master
alloystory Apr 16, 2020
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
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ asciidoctor {
idseparator: '-',
'site-root': "${sourceDir}", // must be the same as sourceDir, do not modify
'site-name': 'AddressBook-Level3',
'site-githuburl': 'https://github.com/se-edu/addressbook-level3',
'site-githuburl': 'https://github.com/AY1920S2-CS2103T-W16-2/main',
'site-seedu': true, // delete this line if your project is not a fork (not a SE-EDU project)
]

Expand Down
43 changes: 21 additions & 22 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,50 @@
:imagesDir: images
:stylesDir: stylesheets

AddressBook - Level 3 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} +
*AkshayFit* was developed by the following team.

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>>]

Role: Project Advisor
=== Liow Jia Chen
image::jiachen247.jpeg[width="150", align="left"]
{empty}[http://www.comp.nus.edu.sg/~jiachen[homepage]] [https://github.com/jiachen247[github]] [<<jiachen247#, portfolio>>]

Role: Developer +
Responsibilities: DevOps
'''

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

Role: Team Lead +
Role: Developer +
Responsibilities: UI

'''

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

Role: Developer +
Responsibilities: Data

'''

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

Role: Developer +
Responsibilities: Dev Ops + Threading
Responsibilities: Threading

'''

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

Role: Developer +
Responsibilities: UI
Expand Down
4 changes: 2 additions & 2 deletions docs/ContactUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
:site-section: ContactUs
:stylesDir: stylesheets

* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S2-CS2103T-W16-2/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
* *Email us* : You can also reach us at `jiachen [at] u.nus.edu`
2 changes: 1 addition & 1 deletion docs/DevOps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ifdef::env-github[]
:note-caption: :information_source:
:warning-caption: :warning:
endif::[]
:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
:repoURL: https://github.com/AY1920S2-CS2103T-W16-2/main/tree/master

== Build Automation

Expand Down
163 changes: 116 additions & 47 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= AddressBook Level 3 - Developer Guide
= ZeroToOne - Developer Guide
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand All @@ -14,7 +14,7 @@ ifdef::env-github[]
endif::[]
:repoURL: https://github.com/se-edu/addressbook-level3/tree/master

By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
By: `Team AY1920S2 W16-2`      Since: `Feb 2020`

== Setting up

Expand Down Expand Up @@ -279,13 +279,15 @@ Refer to the guide <<DevOps#, here>>.

*Target user profile*:

* has a need to manage a significant number of contacts
* prefer desktop apps over other types
* can type fast
* prefers typing over mouse input
* is reasonably comfortable using CLI apps
* Enjoys exercising and does it regularly
* Has a need to manage a significant number of workouts
* Prefers desktop apps over other types
* Can type fast
* Prefers typing over mouse input
* Is reasonably comfortable using CLI apps

*Value proposition*: manage contacts faster than a typical mouse/GUI driven app
*Value proposition*:
Manage workouts faster than a typical mouse/GUI-driven app

[appendix]
== User Stories
Copy link

Choose a reason for hiding this comment

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

Make sure all user stories are grammatically correct. I see some inconsistencies.

As a user......., I want TO ......., so that I can .......

Expand All @@ -295,88 +297,155 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
[width="59%",cols="22%,<23%,<25%,<30%",options="header",]
|=======================================================================
|Priority |As a ... |I want to ... |So that I can...
|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App
|`* * *` |User with many different workouts |Keep track of all my workouts |Stay organised

|`* * *` |user |add a new person |
|`* * *` |User that is busy with multiple commitments |Keep on schedule for my exercise regime |Stay disciplined and keep exercising regularly

|`* * *` |user |delete a person |remove entries that I no longer need
|`* * *` |User who has exercise goals |See or track my current progress |Check if I am reaching my goals

|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
|`* * *` |User who has exercise goals |Set and adjust goals accordingly |Make plans to reach my goals, and improve upon those plans as I see fit

|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
|`* * *` |User who wants to track live progress while exercising |Have a timer for each part of my workout |Stay on schedule for each workout session I do

|`*` |user with many persons in the address book |sort persons by name |locate a person easily
|=======================================================================
|`* *` |User who does exercises in sets |Keep track of how many repetitions per exercise |Know the details of each exercise

|`* *` |User who has a regular workout schedule, but likes to schedule one-off sessions |Some way to keep track of both regular and one-off workouts |Differentiate between the workouts and manage them both simultaneously

|`* *` |User who loses motivation over a long period of time |Something to help me stay motivated |Keep going and not give up halfway

|`* *` |User who lacks self discipline at times |Something to help me maintain the discipline to stay on track |Stick to a regular exercise schedule and regime

|`* *` |User who needs some inspiration or a change of pace |Have sample workout routines to follow |Get more ideas and ways to structure my workouts and find new exercises

|`* *` |User who enjoys graphical displays |Have a graphical overview of various health statistics |Easily comprehend and view my statistics

|`* *` |User who enjoys exercising and discussing it |Share my workout routines with my friends |Help each other out by sharing new exercise regimes

|`* *` |User who has many different types of workouts |To categorize the different types of workout |Achieve better organisation

|`* *` |User who has many different workouts and exercises |To have an overview of all my workout related information |Achieve better organisation

|`*` |New user who is not familiar with setting up exercise regimes |To have a way to consult with fitness trainers or professionals |Gain better knowledge and understanding of exercise regimes

|`*` |User who is sociable and largely influenced by my peers |To see my friends’ progress and achievements |Motivate myself to work harder and help each other out

|`*` |User who sometimes gets a little bored when working out |To have a way to entertain or distract myself when working out |Keep myself on the task at hand by giving an extra motivation boost

_{More to be added}_
|`*` |User who enjoys exercising to music that matches the exercise |To have music tailored to my current workout |Have even more fun with my workouts
|=======================================================================

[appendix]
== Use Cases

(For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)
(For all use cases below, the *System* is the `ZeroToOne` and the *Actor* is the `user`, unless specified otherwise)

[discrete]
=== Use case: Delete person
=== Use Case 1: Adding Exercises to Workout

*MSS*

1. User requests to list persons
2. AddressBook shows a list of persons
3. User requests to delete a specific person in the list
4. AddressBook deletes the person
1. User requests for the existing exercises in the workout
2. System shows a list of the existing exercises
3. User requests to add an exercise to the workout
4. System adds the exercise to the workout
+
Use case ends.

*Extensions*

[none]
* 2a. The list is empty.
* 2a. The requested workout does not exist
** 2a1. Use case ends
+

* 2b. There are no exercises in the workout
** 2b1. System shows a message to inform the user

Choose a reason for hiding this comment

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

2b1. Consider prompting the user to create the new non-existent workout.

+
Use case resumes at step 2
Copy link

Choose a reason for hiding this comment

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

Won't this get stuck up in a loop?

It should instead resume at step 3.


* 3a. User request format is invalid
** 3a1. System shows an error message
+
Use case resumes at step 3

[discrete]
=== Use Case 2: Deleting Workouts

*MSS*

1. User requests to list workouts
2. System shows a list of all workouts
3. User requests to delete a specific workout
4. System deletes the workout
+
Use case ends.

* 3a. The given index is invalid.
*Extensions*

[none]
* 2a. The list is empty
+
Use case ends

* 3a. The given user index is invalid
** 3a1. System shows an error message
+
Use case resumes at step 2

[discrete]
=== Use Case 3: Find Past Workout by Keyword

*MSS*

1. User requests a log of past workouts
2. System shows a list of all past logged workouts
3. User requests to find a past workout by keyword
4. System shows the past workouts that match the keyword
+
Use case ends

*Extensions*

[none]
** 3a1. AddressBook shows an error message.
* 2a. The log is empty
+
Use case resumes at step 2.
Use case ends

_{More to be added}_
* 3a. The keyword does not match any past workouts
** 3a1. System shows an error message
+
Use case ends

[appendix]
== Non Functional Requirements

. Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed.
. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
. Should be able to hold up to 100 workouts a noticeable sluggishness in performance for typical usage.
. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.

_{More to be added}_
. Should not depend on a remote server, so that a user can exercise in any condition or environment.

[appendix]
== Glossary
Copy link

Choose a reason for hiding this comment

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

Would be better if you could add Workout and Session as well and any other terms you feel are relevant.


[[mainstream-os]] Mainstream OS::
Windows, Linux, Unix, OS-X
[[cli]]CLI::
Stands for Command Line Interface, which processes commands to a computer program in the form of lines of text.

[[private-contact-detail]] Private contact detail::
A contact detail that is not meant to be shared with others
[[exercise]]Exercise::
A single type of exercise, for example push ups or crunches.
GUI
Copy link

Choose a reason for hiding this comment

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

This line gets concatenated to the previous one.

Stands for Graphical User Interface, which is a form of user interface that allows users to interact with electronic devices through graphical means, not textual means.

[appendix]
== Product Survey
[[instance]]Instance::
A specific instantiation of an object.

*Product Name*

Author: ...

Pros:

* ...
* ...
[[mainstream-os]] Mainstream OS::
Windows, Linux, Unix, OS-X

Cons:
[[schedule]]Schedule::
A workout that has been planned to be carried out on a specific date or dates.

* ...
* ...
[[workout]]Workout::
A set of exercises to be done together, in a certain order and time frame.

[appendix]
== Instructions for Manual Testing
Expand Down
2 changes: 1 addition & 1 deletion docs/Documentation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ifdef::env-github[]
:note-caption: :information_source:
:warning-caption: :warning:
endif::[]
:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
:repoURL: https://github.com/AY1920S2-CS2103T-W16-2/main/tree/master

== Introduction

Expand Down
2 changes: 1 addition & 1 deletion docs/SettingUp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ifdef::env-github[]
:note-caption: :information_source:
:warning-caption: :warning:
endif::[]
:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
:repoURL: https://github.com/AY1920S2-CS2103T-W16-2/main/tree/master

== Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs/Testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ifdef::env-github[]
:note-caption: :information_source:
:warning-caption: :warning:
endif::[]
:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
:repoURL: https://github.com/AY1920S2-CS2103T-W16-2/main/tree/master

== Running Tests

Expand Down
Loading