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

[T09-2] Anakin #65

Open
wants to merge 591 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 228 commits
Commits
Show all changes
591 commits
Select commit Hold shift + click to select a range
3c72e1a
Update Tests
kr0stofa Oct 29, 2018
3a24530
Merge pull request #166 from Lessthanfree/ImportExportFeature
kr0stofa Oct 29, 2018
730a154
Fix bugs related to import deck command
thanh-ntt Oct 29, 2018
6946cdd
Fix style
thanh-ntt Oct 29, 2018
8570a75
Merge pull request #168 from truongthanh2606/master
thanh-ntt Oct 29, 2018
39396b8
Update exception handling for ImportDeckCommand
kr0stofa Oct 29, 2018
a70b678
Move some command messages to Messages.java
kr0stofa Oct 29, 2018
bd74a70
Formatting
kr0stofa Oct 29, 2018
c682539
More Formatting
kr0stofa Oct 29, 2018
8a90183
Add FindCommandSystemTest Deck level checks (#165)
J0 Oct 29, 2018
a9876ab
Update exception handling for ImportDeckCommand
kr0stofa Oct 29, 2018
85f94a2
Move some command messages to Messages.java
kr0stofa Oct 29, 2018
099885d
Formatting
kr0stofa Oct 29, 2018
1e9b17a
More Formatting
kr0stofa Oct 29, 2018
825cbbd
Improve tests
kr0stofa Oct 30, 2018
d40f62f
Merge branch 'LocalFixImportExceptions' into FixImportExceptions
kr0stofa Oct 30, 2018
10b2ed3
Formatting
kr0stofa Oct 30, 2018
059ae45
Resolve issue #162, update exceptions thrown with cards operation
thanh-ntt Oct 30, 2018
c1f4634
Fix style
thanh-ntt Oct 30, 2018
207bcdb
Fix ExportDeckCommandTest
kr0stofa Oct 30, 2018
f6098b4
Remove 2 tests from ExportDeckCommandTest
kr0stofa Oct 30, 2018
4207dbe
More Formatting
kr0stofa Oct 30, 2018
6ef19f0
Merge pull request #170 from Lessthanfree/FixImportExceptions
kr0stofa Oct 30, 2018
0f13f32
Merge remote-tracking branch 'origin/master'
thanh-ntt Oct 30, 2018
e557362
Fix style
thanh-ntt Oct 30, 2018
5421c3d
Add list command and tests
thanh-ntt Oct 30, 2018
19f8127
Merge pull request #171 from truongthanh2606/master
thanh-ntt Oct 30, 2018
4bfd5c7
Add ability to review decks (#178)
yujiatay Oct 31, 2018
45305ff
Uncomment system tests
yujiatay Oct 31, 2018
7990d5e
Fix styles
yujiatay Oct 31, 2018
4734f5d
Fix styles
yujiatay Oct 31, 2018
091b8fe
Fix help command system test
yujiatay Oct 31, 2018
afdf898
Merge pull request #179 from yujiatay/fix-systemtests
kr0stofa Oct 31, 2018
bf10b4c
Update user guide (#180)
kr0stofa Oct 31, 2018
74e8e31
Clear nodes when updating with new card (#182)
yujiatay Oct 31, 2018
a729214
Change relative paths for readme images
yujiatay Oct 31, 2018
d66d8c8
Remove site-seedu
yujiatay Oct 31, 2018
4901fa4
Add sections 4 to 6 to dev guide
yujiatay Oct 31, 2018
95efb68
Spacing magic for user guide
yujiatay Oct 31, 2018
19e0788
Merge pull request #183 from yujiatay/update-user-guide
thanh-ntt Oct 31, 2018
d82d409
Add project portfolio
thanh-ntt Oct 31, 2018
b4af094
Merge remote-tracking branch 'origin/master'
thanh-ntt Oct 31, 2018
9a36bb1
Devguide Update
kr0stofa Oct 31, 2018
cb7fb05
Update docs (#184)
yujiatay Oct 31, 2018
a49cb18
Merge branch 'master' into updateDevGuide
kr0stofa Oct 31, 2018
682d48a
Performance tracking - Add classify command and related utils (#186)
tomforge Oct 31, 2018
8682aa2
Update DevGuide
kr0stofa Oct 31, 2018
1a1cb4d
Merge branch 'master' into updateDevGuide
kr0stofa Oct 31, 2018
fcb3e87
Merge pull request #188 from Lessthanfree/updateDevGuide
kr0stofa Oct 31, 2018
acaaa3e
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 1, 2018
c9f84cf
Add tests for 4 commands: review, endreview, nextcard, previouscard
thanh-ntt Nov 1, 2018
c5fb99e
Fix style
thanh-ntt Nov 1, 2018
f15ed6b
Update project portfolio
thanh-ntt Nov 1, 2018
44b1bd8
Modify tests for endreview, previouscard and nextcard commands
thanh-ntt Nov 1, 2018
b09d495
Merge pull request #192 from truongthanh2606/master
thanh-ntt Nov 1, 2018
7d1b31b
Modify card and deck-level commands, update userguide, developerguide
thanh-ntt Nov 1, 2018
59aa8f5
Fix test classes
thanh-ntt Nov 1, 2018
52f31a1
Merge pull request #195 from truongthanh2606/master
thanh-ntt Nov 1, 2018
477dde0
Update project portfolio
thanh-ntt Nov 1, 2018
5aa831a
Update deck review (#189)
yujiatay Nov 1, 2018
1c9b70e
update proj portfolio (#196)
tomforge Nov 1, 2018
4396b36
Attempt to fix undo-cd bug
kr0stofa Nov 1, 2018
3f864d3
Implement a currentDeck in Anakin
kr0stofa Nov 1, 2018
0374daf
Update developer guide, project portfolio
thanh-ntt Nov 1, 2018
a05c26c
Merge branch 'master' into master
thanh-ntt Nov 1, 2018
4a802e7
Update project portfolio
thanh-ntt Nov 1, 2018
201a369
Implement justEnteredDeck
kr0stofa Nov 1, 2018
34aaf1c
Update developer guide, project portfolio (#199)
thanh-ntt Nov 1, 2018
22dbd3b
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 1, 2018
d60046b
Add justEnteredDeck flag to block undo
kr0stofa Nov 1, 2018
976048f
Fix import exception handling and add portfolio
kr0stofa Nov 1, 2018
298ce3a
Update ui component diagram
yujiatay Nov 1, 2018
1ea047b
Merge branch 'master' into cdUnredoable
kr0stofa Nov 1, 2018
7248a63
Merge pull request #200 from yujiatay/update-ui-diagram
kr0stofa Nov 1, 2018
3613af4
Merge branch 'master' into cdUnredoable
kr0stofa Nov 1, 2018
beedc03
Attempt to fix undo-cd bug
kr0stofa Nov 1, 2018
63104ff
Implement a currentDeck in Anakin
kr0stofa Nov 1, 2018
ea00553
Implement justEnteredDeck
kr0stofa Nov 1, 2018
ec699c7
Add justEnteredDeck flag to block undo
kr0stofa Nov 1, 2018
8dedfe0
Fix import exception handling and add portfolio
kr0stofa Nov 1, 2018
1e536e7
Refactor short method name and fix typos
kr0stofa Nov 1, 2018
d4f932d
Combine similar model components
kr0stofa Nov 1, 2018
015fc20
Merge branch 'cdUnredoablelocal' into cdUnredoable
kr0stofa Nov 1, 2018
266a430
Format UG,DG and portfolio
kr0stofa Nov 1, 2018
2dc7cae
Clean up, fix broken tests
kr0stofa Nov 2, 2018
e8ecd0e
Merge pull request #201 from Lessthanfree/cdUnredoable
kr0stofa Nov 2, 2018
aa05476
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 2, 2018
4a9f2e2
Update user guide, add leeyjjoel.adoc (#202)
J0 Nov 2, 2018
88f8d15
Change the logic of executing commands
thanh-ntt Nov 2, 2018
b3d1bd0
Fix style
thanh-ntt Nov 2, 2018
49dbb7c
Fix style
thanh-ntt Nov 2, 2018
fa6058f
Merge pull request #209 from truongthanh2606/master
thanh-ntt Nov 2, 2018
bf82888
Resolve issues #211, #212, #213, #214, #217
thanh-ntt Nov 3, 2018
f6d9d7d
Resolve issues #211, #212, #213, #214, #217 (#218)
thanh-ntt Nov 3, 2018
b474b2e
Add LogicManagerTest
Nov 4, 2018
72ea12e
Change exportdeck to export in user guide
Nov 4, 2018
0017dad
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 4, 2018
85f9ad9
Merge pull request #238 from leeyjjoel/LogicManagerTest
thanh-ntt Nov 4, 2018
e571aee
Update userguide on multiple arguments and import format (#233)
J0 Nov 4, 2018
2481a47
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 4, 2018
a1fd401
Add messages to `undo` command
thanh-ntt Nov 4, 2018
39493c9
Fix style
thanh-ntt Nov 4, 2018
9d367ba
Make Travis happy
thanh-ntt Nov 4, 2018
0cd4778
Merge pull request #241 from truongthanh2606/master
thanh-ntt Nov 4, 2018
049922c
Update message for `redo`, resolve issue #219
thanh-ntt Nov 4, 2018
fe0bdfa
Merge pull request #243 from truongthanh2606/master
thanh-ntt Nov 5, 2018
04a72bb
streamline difficulties, use only "easy", "normal", and "hard"
tomforge Nov 5, 2018
efaf48f
remove default difficulty, use "normal" instead
tomforge Nov 5, 2018
7cc702f
elaborate on difficulty and the use of the classify command
tomforge Nov 5, 2018
c68e27a
correct naming for PPP
tomforge Nov 5, 2018
eb3cf9b
use times reviewed instead of times classified
tomforge Nov 5, 2018
ef86fd4
fixes #187
tomforge Nov 5, 2018
feaad62
rename Performance string to type
tomforge Nov 5, 2018
6211ec8
streamline Performance parsing
tomforge Nov 5, 2018
e2293fb
Add newdeckcommand system tests (#242)
J0 Nov 6, 2018
d9a7fa3
streamline performance enum and parsing
tomforge Nov 6, 2018
044ab94
move string to performance parsing into performance enum
tomforge Nov 6, 2018
4c47be1
add valid performance check in Performance enum
tomforge Nov 6, 2018
25f1c5f
add Card meta fields to storage
tomforge Nov 6, 2018
91fe2a5
display difficulty on UI
tomforge Nov 6, 2018
28920f6
fix styles
tomforge Nov 6, 2018
ff95b3a
Merge branch 'master' into classify-enhancements
tomforge Nov 6, 2018
1d7b6df
update UG/DG for classify
tomforge Nov 6, 2018
bccb868
fix styles, add comments
tomforge Nov 6, 2018
ba88214
add performance to card test
tomforge Nov 6, 2018
8154f48
use classification to track times reviewed
tomforge Nov 6, 2018
56602c1
add performance ParserUtil tests
tomforge Nov 6, 2018
115b02f
Merge pull request #245 from tomforge/classify-enhancements
kr0stofa Nov 6, 2018
703ae4a
Initial commit
kr0stofa Nov 2, 2018
823ed4a
Add tests to Parser Test and ReviewCommandParser tests
kr0stofa Nov 2, 2018
ff017a2
Add ClassifyCard Parser test
kr0stofa Nov 4, 2018
b5c8e10
Fix Formatting
kr0stofa Nov 5, 2018
1eb74ff
Fix Imports
kr0stofa Nov 5, 2018
1ea0900
Update ClassifyCommandParser test and SortCommandTest
kr0stofa Nov 5, 2018
e2fcb84
Adapt tests to Classify command changes
kr0stofa Nov 6, 2018
4775c64
Fix build errors
kr0stofa Nov 6, 2018
5c82670
Fix Format
kr0stofa Nov 6, 2018
8aee5cf
Add Question tests to ParserUtilTest
kr0stofa Nov 6, 2018
1228f09
Fix import and variable declaration
kr0stofa Nov 6, 2018
fa5b6ff
Comment out asciidoc errors in johndoe.adoc
kr0stofa Nov 6, 2018
acfe55e
Update user guide, project portfolio
thanh-ntt Nov 6, 2018
24e8a6c
Update user guide, project portfolio (#247)
thanh-ntt Nov 6, 2018
3f3371c
Merge branch 'master' into ParserTest
kr0stofa Nov 7, 2018
101cacc
Merge pull request #240 from Lessthanfree/ParserTest
kr0stofa Nov 7, 2018
7d2382f
Fixes #208, remove method call of unused browserpanel
yujiatay Nov 7, 2018
1a4b10c
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 7, 2018
8ca7f2d
Merge pull request #251 from yujiatay/bug-fix
kr0stofa Nov 7, 2018
9a9e5ee
Add autocomplete functionality (#248)
J0 Nov 7, 2018
644ade4
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 7, 2018
3749b8e
Add more tests to increase coverage (#250)
yujiatay Nov 8, 2018
01f247a
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 8, 2018
2b7288c
Add tests
thanh-ntt Nov 8, 2018
cf90bfb
Fix style
thanh-ntt Nov 8, 2018
3ed3f5c
Update PortManager test
kr0stofa Nov 8, 2018
c615543
Formatting
kr0stofa Nov 8, 2018
9551918
Merge pull request #255 from truongthanh2606/master
thanh-ntt Nov 8, 2018
0d96ca3
Add jadoc comment
kr0stofa Nov 8, 2018
26b8de7
Merge branch 'master' into PortManagerTest
kr0stofa Nov 8, 2018
2e01e77
add sampleDataUtil tests
tomforge Nov 8, 2018
0ca4059
formatting
tomforge Nov 8, 2018
8fd47f8
Enhance ExportDeckCommand test
kr0stofa Nov 8, 2018
d769a58
fix formatting
tomforge Nov 8, 2018
5782edd
fix style
tomforge Nov 8, 2018
d4e006e
Merge pull request #256 from Lessthanfree/PortManagerTest
kr0stofa Nov 8, 2018
f2ee0dc
Merge branch 'master' into add-tests
tomforge Nov 8, 2018
72829be
Merge pull request #257 from tomforge/add-tests
thanh-ntt Nov 8, 2018
c522c31
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 8, 2018
4ca166a
Add system tests for edit deck command (#244)
J0 Nov 8, 2018
aefc760
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 8, 2018
7095898
Resolve issue #228 #249
thanh-ntt Nov 8, 2018
1cc1dea
Update user guide and project portfolio
thanh-ntt Nov 8, 2018
fcb5525
Add logging info
thanh-ntt Nov 8, 2018
97ebbff
Resolve issue #228 #249 (#258)
thanh-ntt Nov 8, 2018
8970823
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 8, 2018
faa88e9
Update my docs
kr0stofa Nov 7, 2018
dab517e
Update PPP
kr0stofa Nov 7, 2018
83c4d17
Reposense code
kr0stofa Nov 9, 2018
2921c42
Add Performance sort command
Nov 11, 2018
3d011c2
Add review score and next review date to card
Nov 11, 2018
3ab97fc
Change sort to accept sort types
Nov 11, 2018
9656657
Modify card list to perform performance sort
Nov 11, 2018
cef607c
Augment performance enum
Nov 11, 2018
7e47558
Add documentation for Card methods
Nov 11, 2018
987f3fa
Fix style errors
Nov 11, 2018
afbe4c6
Update documents and add 5 screenshots
kr0stofa Nov 11, 2018
fe567d1
Merge pull request #263 from Lessthanfree/Documentation
thanh-ntt Nov 11, 2018
1ff7302
Acknowledge Jethro Kuan for suggestions
Nov 11, 2018
0ee64e9
Integrate performance sort to parser
Nov 11, 2018
b253a25
Merge branch 'master' of https://github.com/CS2103-AY1819S1-T09-2/main
Nov 11, 2018
70b986b
Add bias, update threshold
Nov 11, 2018
ec048c8
Refactor if else loops
Nov 11, 2018
4da4d8e
Update isCorrect core calculation in Performance
Nov 11, 2018
64937b2
Remove reviewed property of card
Nov 11, 2018
665f11e
Change Alphabetical to Lexicographical sort
Nov 11, 2018
6b38a9b
Change Alphabetical to Lexicographical sort
Nov 11, 2018
a4175b9
Add documentation for Card methods
Nov 11, 2018
db9c4a1
Add initial helper methods for performance sort tests
Nov 11, 2018
f28fdc5
Update PPP, fix style errors
Nov 11, 2018
3e4eee7
Remove unused constant
Nov 11, 2018
0dd507a
Shorten document (#264)
kr0stofa Nov 11, 2018
e8d7ff2
Merge branch 'master' into master
J0 Nov 11, 2018
4cd3cf7
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 11, 2018
a20e34f
Update ug/dg/ppp (#265)
tomforge Nov 11, 2018
8ee4331
Merge branch 'master' into master
kr0stofa Nov 11, 2018
11cb17b
Update user guide with rank command
Nov 11, 2018
944abf9
Merge branch 'master' of https://github.com/CS2103-AY1819S1-T09-2/main
Nov 11, 2018
87d86bd
Rename test
Nov 11, 2018
b323a93
Update project portfolio, developer guide
thanh-ntt Nov 11, 2018
efc7765
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 11, 2018
0bfea7e
Add scheduling for cards (#262)
J0 Nov 11, 2018
99d3bee
Update user guide, project portfolio (#266)
thanh-ntt Nov 11, 2018
6e47f6b
Update PPP (#267)
yujiatay Nov 11, 2018
87fcb06
Remove unused import
Nov 11, 2018
202001c
Resolve merge conflicts
Nov 11, 2018
726c667
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 12, 2018
76a1f81
Update PPP
thanh-ntt Nov 12, 2018
23f5d58
Merge pull request #269 from truongthanh2606/master
kr0stofa Nov 12, 2018
ae9c1a8
Fix formatting of import documentation
kr0stofa Nov 12, 2018
3f26577
Add ability to filter by card difficulty with list command (#271)
tomforge Nov 12, 2018
58100fb
Merge branch 'master' into finalDocs
J0 Nov 12, 2018
c19de40
Fix formatting of import documentation
kr0stofa Nov 12, 2018
24d2f7d
Update User Guide
kr0stofa Nov 12, 2018
2e43bcd
Add Manual Testing Appendix to DevGuide
kr0stofa Nov 12, 2018
66e547e
Merge remote-tracking branch 'Lessthanfree/finalDocs' into finalDocs
kr0stofa Nov 12, 2018
e18e85e
Fix typo in Userguide
kr0stofa Nov 12, 2018
4b5313a
Update Devguide
thanh-ntt Nov 12, 2018
6c3d8b9
Fix Typo in Devguide
thanh-ntt Nov 12, 2018
1426cb6
Update Devguide
thanh-ntt Nov 12, 2018
8411055
Tweak Devguide appendix
kr0stofa Nov 12, 2018
6a6d95b
Update ppp
thanh-ntt Nov 12, 2018
ea4ca17
Merge pull request #272 from Lessthanfree/finalDocs
kr0stofa Nov 12, 2018
53b72ce
Merge branch 'master' into master
thanh-ntt Nov 12, 2018
e03533a
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 12, 2018
293e6e2
[WIP]: Update PPP (#268)
J0 Nov 12, 2018
aa9bfa5
Merge branch 'master' of https://github.com/leeyjjoel/Main
Nov 12, 2018
3fcaa26
Resolve merge conflicts
Nov 12, 2018
f0117b8
Merge branch 'master' into master
kr0stofa Nov 12, 2018
97e7e25
Merge pull request #273 from truongthanh2606/master
thanh-ntt Nov 12, 2018
ed590c6
Merge remote-tracking branch 'origin/master'
thanh-ntt Nov 12, 2018
53f4760
Fix image not shown bug
thanh-ntt Nov 12, 2018
603c7c1
Fix Grammar add developer guide section
Nov 12, 2018
c41e05a
Merge branch 'master' into updateDevGuide
J0 Nov 12, 2018
dc71e94
Merge pull request #274 from truongthanh2606/master
thanh-ntt Nov 12, 2018
f4958a0
Merge branch 'master' into updateDevGuide
J0 Nov 12, 2018
d77bea1
Fix style errors
Nov 12, 2018
5ec1697
Fix style errors
Nov 12, 2018
b7f0251
Merge pull request #275 from leeyjjoel/updateDevGuide
thanh-ntt Nov 12, 2018
66607fb
Update Developer guide
thanh-ntt Nov 12, 2018
c1745e2
Merge pull request #277 from truongthanh2606/master
thanh-ntt Nov 12, 2018
a1ff6b0
Fix grammatical errors in PPP (#278)
J0 Nov 12, 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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ classes/
/bin/
src/main/resources/docs/
out/
*.swp
57 changes: 38 additions & 19 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,40 +1,59 @@
= Address Book (Level 4)
ifdef::env-github[]
image:docs/images/Anakin.png[width="250", align="center"]
endif::[]

ifndef::env-github[]
image:docs/images/Anakin.png[width="200", align="center"]
endif::[]

= Anakin

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://travis-ci.org/CS2103-AY1819S1-T09-2/main?branch=master[image:https://travis-ci.org/CS2103-AY1819S1-T09-2/main.svg?branch=master[Build Status]]
https://ci.appveyor.com/project/leeyjjoel/main/branch/master[image:https://ci.appveyor.com/api/projects/status/qjfbm4fqjffl8ujk/branch/master?svg=true[Build status]]
https://coveralls.io/github/CS2103-AY1819S1-T09-2/main?branch=master[image:https://coveralls.io/repos/github/CS2103-AY1819S1-T09-2/main/badge.svg?branch=master[Coverage Status]]
https://www.codacy.com/app/leeyjjoel/main?utm_source=github.com&utm_medium=referral&utm_content=CS2103-AY1819S1-T09-2/main&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/1bb58958c22c473dbf75c560d5b71612[Codacy Badge]]
https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]


Anakin is a spaced repetition flashcard program which makes remembering things easy.
Here's what some of our users have to say:

[quote, Tan Xiao Ming, Computer Science Graduate]
Amazing work. Simply amazing.

[quote, Donnie T., Political Science Student]
The greatest CLI app, maybe, ever!

[quote, Tony Stark, Billionare; Inventor; Entrepreneur]
Better than Pepper Potts!

[quote, A.Aron Tan, Lecturer]
They did it.

ifdef::env-github[]
image::docs/images/Ui.png[width="600"]
image:docs/images/ui-mockups/Gameplay-Question.png[width="400"]

Choose a reason for hiding this comment

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

UI mockups should be 1 screenshot

image:docs/images/ui-mockups/Gameplay-Answer.png[width="400"]

Choose a reason for hiding this comment

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

You need to have your one of your images named "docs/images/Ui.png" so that our scripts can download it.

endif::[]

ifndef::env-github[]
image::images/Ui.png[width="600"]
image:docs/images/ui-mockups/Gameplay-Question.png[width="400"]
image:docs/images/ui-mockups/Gameplay-Answer.png[width="400"]
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.


== Site Map

* <<UserGuide#, User Guide>>

Choose a reason for hiding this comment

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

You should remove the link to Learning Outcomes in your final product.

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

== 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_.
* This project is based off the exceptional https://github.com/se-edu/[AddressBook-Level4] developed by SE-EDU.
* Libraries used: 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/junit5[JUnit5]
* Darth Vadar icon by https://thenounproject.com/Alone_Forever/uploads/?i=1799999[Alone_Forever]

== Licence : link:LICENSE[MIT]
== Licence: link:LICENSE[MIT]
25 changes: 25 additions & 0 deletions _reposense/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"authors":
[
{
"githubId": "leeyjjoel",
"authorNames": ["leeyjjoel", "Lee Yi Jie Joel"]
},
{
"githubId": "lessthanfree",
"authorNames": ["lessthanfree", "David Goh"]
},
{
"githubId": "tomforge",
"authorNames": ["tomforge", "Foo Guo Wei"]
},
{
"githubId": "yujiatay",
"authorNames": ["yujiatay", "Yu Jia Tay"]
},
{
"githubId": "truongthanh2606",
"authorNames": ["truongthanh2606", "Truong Thanh"]
}
]
}
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ asciidoctor {
idprefix: '', // for compatibility with GitHub preview
idseparator: '-',
'site-root': "${sourceDir}", // must be the same as sourceDir, do not modify
'site-name': 'AddressBook-Level4',
'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
'site-name': 'Anakin',
'site-githuburl': 'https://github.com/CS2103-AY1819S1-T09-2/main',
'site-seedu': true, // delete this line if your project is not a fork (not a SE-EDU project)
]

Expand Down
68 changes: 41 additions & 27 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,67 @@
: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} +
Anakin was the brainchild of the T09-02 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>>]
=== Joel Lee
image::leeyjjoel.png[width="150", align="left"]
{empty}[http://github.com/leeyjjoel[github]] [<<leeyjjoel#, portfolio>>]

Role: Team Lead

Role: Project Advisor
.Responsibilities:
- Project Management

'''

=== John Roe
image::lejolly.jpg[width="150", align="left"]
{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
=== Foo Guo Wei
image::tomforge.png[width="150", align="left"]
{empty} [https://github.com/tomforge[github]] [<<tomforge#, portfolio>>]

Role: Developer

Role: Team Lead +
Responsibilities: UI
.Responsibilities:
- Git expert
- In charge of Model

'''

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

Role: Developer +
Responsibilities: Data
Role: Developer

.Responsibilities:
- IntelliJ expert
- In charge of UI

'''

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

Choose a reason for hiding this comment

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

@Lessthanfree Your picture may need to be changed such that your face can be seen more clearly.

{empty}[http://github.com/lessthanfree[github]] [<<lessthanfree#, portfolio>>]

Role: Developer

Role: Developer +
Responsibilities: Dev Ops + Threading
.Responsibilities:
- Documentation
- Project Management

'''

=== Benson Meier
image::yl_coder.jpg[width="150", align="left"]
{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
=== Nguyen Trong Truong Thanh
image::truongthanh2606.png[width="150", align="left"]
{empty}[https://github.com/truongthanh2606[github]] [<<truongthanh2606#, portfolio>>]

Role: Developer

Role: Developer +
Responsibilities: UI
.Responsibilities:
- In charge of Model
- Quality Assurance

'''
2 changes: 1 addition & 1 deletion docs/ContactUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/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 `joel_lee [at] u.nus.edu`
Loading