-
Notifications
You must be signed in to change notification settings - Fork 64
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
base: master
Are you sure you want to change the base?
[T09-2] Anakin #65
Changes from 228 commits
3c72e1a
3a24530
730a154
6946cdd
8570a75
39396b8
a70b678
bd74a70
c682539
8a90183
a9876ab
85f94a2
099885d
1e9b17a
825cbbd
d40f62f
10b2ed3
059ae45
c1f4634
207bcdb
f6098b4
4207dbe
6ef19f0
0f13f32
e557362
5421c3d
19f8127
4bfd5c7
45305ff
7990d5e
4734f5d
091b8fe
afdf898
bf10b4c
74e8e31
a729214
d66d8c8
4901fa4
95efb68
19e0788
d82d409
b4af094
9a36bb1
cb7fb05
a49cb18
682d48a
8682aa2
1a1cb4d
fcb3e87
acaaa3e
c9f84cf
c5fb99e
f15ed6b
44b1bd8
b09d495
7d1b31b
59aa8f5
52f31a1
477dde0
5aa831a
1c9b70e
4396b36
3f864d3
0374daf
a05c26c
4a802e7
201a369
34aaf1c
22dbd3b
d60046b
976048f
298ce3a
1ea047b
7248a63
3613af4
beedc03
63104ff
ea00553
ec699c7
8dedfe0
1e536e7
d4f932d
015fc20
266a430
2dc7cae
e8ecd0e
aa05476
4a9f2e2
88f8d15
b3d1bd0
49dbb7c
fa6058f
bf82888
f6d9d7d
b474b2e
72ea12e
0017dad
85f9ad9
e571aee
2481a47
a1fd401
39493c9
9d367ba
0cd4778
049922c
fe0bdfa
04a72bb
efaf48f
7cc702f
c68e27a
eb3cf9b
ef86fd4
feaad62
6211ec8
e2293fb
d9a7fa3
044ab94
4c47be1
25f1c5f
91fe2a5
28920f6
ff95b3a
1d7b6df
bccb868
ba88214
8154f48
56602c1
115b02f
703ae4a
823ed4a
ff017a2
b5c8e10
1eb74ff
1ea0900
e2fcb84
4775c64
5c82670
8aee5cf
1228f09
fa5b6ff
acfe55e
24e8a6c
3f3371c
101cacc
7d2382f
1a4b10c
8ca7f2d
9a9e5ee
644ade4
3749b8e
01f247a
2b7288c
cf90bfb
3ed3f5c
c615543
9551918
0d96ca3
26b8de7
2e01e77
0ca4059
8fd47f8
d769a58
5782edd
d4e006e
f2ee0dc
72829be
c522c31
4ca166a
aefc760
7095898
1cc1dea
fcb5525
97ebbff
8970823
faa88e9
dab517e
83c4d17
2921c42
3d011c2
3ab97fc
9656657
cef607c
7e47558
987f3fa
afbe4c6
fe567d1
1ff7302
0ee64e9
b253a25
70b986b
ec048c8
4da4d8e
64937b2
665f11e
6b38a9b
a4175b9
db9c4a1
f28fdc5
3e4eee7
0dd507a
e8d7ff2
4cd3cf7
a20e34f
8ee4331
11cb17b
944abf9
87d86bd
b323a93
efc7765
0bfea7e
99d3bee
6e47f6b
87fcb06
202001c
726c667
76a1f81
23f5d58
ae9c1a8
3f26577
58100fb
c19de40
24d2f7d
2e43bcd
66e547e
e18e85e
4b5313a
6c3d8b9
1426cb6
8411055
6a6d95b
ea4ca17
53b72ce
e03533a
293e6e2
aa9bfa5
3fcaa26
f0117b8
97e7e25
ed590c6
53f4760
603c7c1
c41e05a
dc71e94
f4958a0
d77bea1
5ec1697
b7f0251
66607fb
c1745e2
a1ff6b0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,4 @@ classes/ | |
/bin/ | ||
src/main/resources/docs/ | ||
out/ | ||
*.swp |
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"] | ||
image:docs/images/ui-mockups/Gameplay-Answer.png[width="400"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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>> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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] |
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"] | ||
} | ||
] | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
||
''' |
There was a problem hiding this comment.
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