Skip to content

[CS2103T-T15-2] Flash Notes #82

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

Open
wants to merge 864 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
864 commits
Select commit Hold shift + click to select a range
aa0d94a
Merge pull request #254 from rachel170/documentation
chuyouchia Nov 6, 2020
e707c0c
Edit List Flashcard command message
Sruthisarav Nov 6, 2020
f990960
Edit testcase error
Sruthisarav Nov 6, 2020
62b46fe
Merge pull request #28 from AY2021S1-CS2103T-T15-2/v1.4
rachel170 Nov 6, 2020
9ef3113
Merge pull request #255 from Sruthisarav/v1.4
chuyouchia Nov 6, 2020
6f26ad5
Update DG
chuyouchia Nov 6, 2020
820e432
Merge branch 'v1.4' of https://github.com/AY2021S1-CS2103T-T15-2/tp i…
chuyouchia Nov 6, 2020
0c105ab
Storage: ResultStatistic should be between 0 and 100
rachel170 Nov 6, 2020
0a94927
Edit error message for large review limit
foongsq Nov 6, 2020
ee2cc65
Edit checkstyle
foongsq Nov 6, 2020
90e0be8
Merge pull request #257 from rachel170/branch-v1.4-bug-fix
chuyouchia Nov 6, 2020
0b8cc29
Fix CI
foongsq Nov 6, 2020
7f06862
Update UG screenshots icon
pengxiangg Nov 6, 2020
a6a0431
Merge pull request #258 from foongsq/update
chuyouchia Nov 6, 2020
a89e169
Merge branch 'v1.4' of https://github.com/AY2021S1-CS2103T-T15-2/tp i…
chuyouchia Nov 6, 2020
6e5ac84
Storage: Allow loading of default statistic value
rachel170 Nov 6, 2020
e396148
Merge pull request #259 from pengxiangg/1.4
chuyouchia Nov 6, 2020
8b64548
Fix checkstyle
rachel170 Nov 6, 2020
1f43834
Merge pull request #260 from rachel170/branch-v1.4-bug-fix
chuyouchia Nov 6, 2020
db0169a
Merge branch 'v1.4' of https://github.com/AY2021S1-CS2103T-T15-2/tp i…
chuyouchia Nov 6, 2020
f248e35
Remove empty box from DG
pengxiangg Nov 6, 2020
97b7a83
Storage: Fix statistic loading
rachel170 Nov 6, 2020
cb23d05
Remove bolding of use cases
pengxiangg Nov 6, 2020
725b282
Merge pull request #261 from pengxiangg/1.4
chuyouchia Nov 6, 2020
e42a988
Merge pull request #262 from rachel170/branch-v1.4-bug-fix
chuyouchia Nov 6, 2020
afcccd4
Add line for use cases
pengxiangg Nov 6, 2020
5ab0961
Merge pull request #263 from pengxiangg/1.4
pengxiangg Nov 6, 2020
6792edd
Merge pull request #264 from chuyouchia/v1.4
chuyouchia Nov 6, 2020
d7bd32f
Merge pull request #265 from AY2021S1-CS2103T-T15-2/v1.4
chuyouchia Nov 6, 2020
2a79d30
Update listAll command for image
pengxiangg Nov 6, 2020
bf00f91
Merge branch 'v1.4' of https://github.com/AY2021S1-CS2103T-T15-2/tp i…
pengxiangg Nov 6, 2020
d3cfb8a
Merge pull request #29 from AY2021S1-CS2103T-T15-2/master
rachel170 Nov 6, 2020
c2d867a
Update to listAll command in UG
pengxiangg Nov 6, 2020
7ffeeb5
Test: JsonAdaptedDeck
rachel170 Nov 6, 2020
cfdfc9d
Merge remote-tracking branch 'origin/master'
rachel170 Nov 6, 2020
b3cf701
Update UG
foongsq Nov 6, 2020
e236de6
Merge branch 'master' into 1.4
pengxiangg Nov 6, 2020
2cdc59b
Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T15-2/tp…
foongsq Nov 6, 2020
b34350e
Make changes to user guide
Sruthisarav Nov 6, 2020
3f97ead
Update listAll image for UG
pengxiangg Nov 6, 2020
2799f97
Revert "Update listAll image for UG"
pengxiangg Nov 6, 2020
55007b1
Merge branch 'master' into v1.4
Sruthisarav Nov 6, 2020
7536093
Remove NFR
pengxiangg Nov 6, 2020
3b3e38b
Merge branch '1.4' of https://github.com/pengxiangg/tp into 1.4
pengxiangg Nov 6, 2020
36ffdde
DG: Fix Link
rachel170 Nov 6, 2020
661e62f
Update use case for DG
pengxiangg Nov 6, 2020
a7528e2
UG: Replace end review image
rachel170 Nov 6, 2020
8c9e7a3
Minor edit to DG
pengxiangg Nov 6, 2020
9033959
Documentation update
rachel170 Nov 6, 2020
49205ce
DG update
rachel170 Nov 6, 2020
55d5f27
Update sequence diagram
rachel170 Nov 6, 2020
6d82bdb
Update use case for DG
pengxiangg Nov 6, 2020
abfc322
DG update
rachel170 Nov 6, 2020
a5d494a
Update heading
pengxiangg Nov 6, 2020
d80ae1c
Update Home Mode to Main Mode
pengxiangg Nov 6, 2020
00b2233
Update home mode to main mode
pengxiangg Nov 6, 2020
10afcd2
Update home to main mode
pengxiangg Nov 6, 2020
9943dab
Add more testcases for Manual Testing
Sruthisarav Nov 6, 2020
2783fc9
Test: Add test to JsonSerializableFlashNotesTest
rachel170 Nov 6, 2020
273d857
Update list command section of UG
pengxiangg Nov 6, 2020
cbcf0da
Fix minor DG bug in use case
pengxiangg Nov 6, 2020
c710531
DG: Remove credit DG
rachel170 Nov 6, 2020
984cb78
Update DG and FNparser
chuyouchia Nov 6, 2020
a3c0fd6
Test: Comment out unused imports
rachel170 Nov 6, 2020
8884a23
Edit Logic Component of DG
Sruthisarav Nov 6, 2020
b900a05
Minor tweaks to DG
foongsq Nov 6, 2020
5d2a8ba
Merge pull request #266 from pengxiangg/1.4
chuyouchia Nov 6, 2020
667ecce
Pull master
Sruthisarav Nov 6, 2020
1e50c1e
CheckStyle fix
rachel170 Nov 6, 2020
a94b79b
Update home mode to main mode in DG
chuyouchia Nov 6, 2020
29a6479
Merge branch 'master' into v1.4
Sruthisarav Nov 6, 2020
4ea2dc8
Merge branch 'master' into v1.4
chuyouchia Nov 6, 2020
f5b60be
Merge branch 'master' into master
rachel170 Nov 6, 2020
e32abb3
Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T15-2/tp…
foongsq Nov 6, 2020
ac9fe83
Merge pull request #269 from chuyouchia/v1.4
chuyouchia Nov 6, 2020
3d60ec5
Merge branch 'master' into v1.4
Sruthisarav Nov 6, 2020
d3b20c0
Merge branch 'master' into update
foongsq Nov 6, 2020
98b6f46
Merge branch 'master' into master
rachel170 Nov 6, 2020
78d819a
Merge pull request #268 from Sruthisarav/v1.4
chuyouchia Nov 6, 2020
62cd04a
Merge branch 'master' into master
rachel170 Nov 6, 2020
2a8c09f
Merge branch 'master' into update
chuyouchia Nov 6, 2020
f4ac6b5
Test: Add tests to JsonSerializableFlashNotesTest
rachel170 Nov 6, 2020
3ac5fb3
Merge pull request #270 from foongsq/update
chuyouchia Nov 6, 2020
2fa1114
Merge branch 'master' into master
rachel170 Nov 6, 2020
2bdf5fe
Merge pull request #267 from rachel170/master
chuyouchia Nov 6, 2020
a8b6c67
Edit a typo
Sruthisarav Nov 6, 2020
12592aa
Pull upstream/master
Sruthisarav Nov 6, 2020
c18666a
Fix minor errors
Sruthisarav Nov 6, 2020
b7f6f6a
Edit DG
Sruthisarav Nov 6, 2020
4da3e39
Add current choice to alternative 1 in DG
pengxiangg Nov 6, 2020
db1a7e8
Merge pull request #271 from Sruthisarav/v1.4
pengxiangg Nov 6, 2020
3375b37
Update DG
chuyouchia Nov 7, 2020
fef9432
Merge branch 'v1.4' of https://github.com/chuyouchia/tp into v1.4
chuyouchia Nov 7, 2020
565d4a0
Merge branch 'master' into v1.4
chuyouchia Nov 7, 2020
d0f8612
Update PPP
chuyouchia Nov 7, 2020
3e5ddb1
Merge branch 'v1.4' of https://github.com/chuyouchia/tp into v1.4
chuyouchia Nov 7, 2020
f9a10c1
Update PPP justification
chuyouchia Nov 7, 2020
a8d6ce6
Finalize PPP
chuyouchia Nov 8, 2020
f940275
Add newline to EOF
chuyouchia Nov 8, 2020
9eae897
Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T15-2/tp
pengxiangg Nov 8, 2020
2e056c7
Fix list bug in UG
pengxiangg Nov 8, 2020
9f897ce
Edit UG
pengxiangg Nov 8, 2020
3eb702c
Edit font size of diagram
pengxiangg Nov 8, 2020
03bb5f7
Edit font size
pengxiangg Nov 8, 2020
69fb6f9
Update DG
pengxiangg Nov 8, 2020
cb3c9d5
Fix typos in UGDG
foongsq Nov 8, 2020
7fdf939
Update DG deleteCard diagram
pengxiangg Nov 8, 2020
53a0055
Fix diagram typos
foongsq Nov 8, 2020
59223e3
Change sample data to avoid confusion
foongsq Nov 8, 2020
f6dd8a5
Update PPP with link to pull request
foongsq Nov 8, 2020
6a9503e
Fix wrong actions in activity diagram
foongsq Nov 8, 2020
0b0f32c
Test: Addition to JsonFlashNotesStorageTest
rachel170 Nov 8, 2020
9f0ffc9
UG: Add note on review statistics
rachel170 Nov 8, 2020
30e47c0
Checkstyle fixes
rachel170 Nov 8, 2020
ea9f0f3
Test: Addition to StorageManagerTest
rachel170 Nov 8, 2020
8937c52
Merge branch 'master' into master
rachel170 Nov 8, 2020
ff7f96c
Edit DG, UG, and PPP
pengxiangg Nov 8, 2020
0dc9f1e
Test: Addition to LogicManagerTest
rachel170 Nov 8, 2020
716883e
Test: Addition to JsonFlashNotesStorageTest
rachel170 Nov 8, 2020
7ba1556
Test: Addition to JsonSerializableFlashNotesTest
rachel170 Nov 8, 2020
38d152a
Update PPP
pengxiangg Nov 8, 2020
80be33e
Update screenshots in UG
foongsq Nov 8, 2020
f222e95
Update Add Deck spacing
chuyouchia Nov 8, 2020
b0319bf
Merge pull request #275 from rachel170/master
chuyouchia Nov 8, 2020
fc3a4cd
Merge branch 'master' into final-changes
chuyouchia Nov 8, 2020
dafb300
Update sample data
foongsq Nov 8, 2020
a9f47df
Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T15-2/tp…
foongsq Nov 8, 2020
4b8f38e
Merge branch 'final-changes' of https://github.com/foongsq/tp into fi…
foongsq Nov 8, 2020
157e213
Merge pull request #274 from foongsq/final-changes
chuyouchia Nov 8, 2020
d748f0d
Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T15-2/tp
pengxiangg Nov 8, 2020
026d86a
Edit minor bullet point to DG
pengxiangg Nov 8, 2020
8e5a834
Edit sample data
pengxiangg Nov 8, 2020
6de17c1
Update swapping of Root Nodes
chuyouchia Nov 8, 2020
c17242c
Merge branch 'master' into v1.4
chuyouchia Nov 8, 2020
f488cd2
Merge pull request #272 from chuyouchia/v1.4
chuyouchia Nov 8, 2020
9be071a
Fix checkstyle
pengxiangg Nov 8, 2020
21594b1
Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T15-2/tp
pengxiangg Nov 8, 2020
c6ccb50
Update DG and UG
pengxiangg Nov 8, 2020
0e3d1c4
Edit logic class diagram
Sruthisarav Nov 8, 2020
e2a3e0b
git pull from upstream/master
Sruthisarav Nov 8, 2020
7c239f8
Merge pull request #30 from AY2021S1-CS2103T-T15-2/master
rachel170 Nov 8, 2020
dcad71c
Merge branch 'master' into v1.4
Sruthisarav Nov 8, 2020
5d8a2e0
Update DeveloperGuide.md
chuyouchia Nov 8, 2020
e7c4d46
Remove header for card implementation for DG
pengxiangg Nov 8, 2020
218b4ec
Merge branch 'master' of https://github.com/pengxiangg/tp
pengxiangg Nov 8, 2020
da06fc0
DG: Minor edit to recent updates
rachel170 Nov 8, 2020
3fc6865
Update DeveloperGuide.md
chuyouchia Nov 8, 2020
94b3a87
Add new line
foongsq Nov 8, 2020
e64573b
Fix DG typo
foongsq Nov 8, 2020
66a5dd9
Fix a bug
Sruthisarav Nov 8, 2020
bd79568
Fix Checkstyle error
Sruthisarav Nov 8, 2020
86e6366
Pull upstream/master
Sruthisarav Nov 8, 2020
ee04659
Merge pull request #277 from Sruthisarav/v1.4
pengxiangg Nov 8, 2020
774d4e5
Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T15-2/tp
pengxiangg Nov 8, 2020
99ad93d
Merge branch 'master' of https://github.com/pengxiangg/tp
pengxiangg Nov 8, 2020
b6f375c
Documentation updates
rachel170 Nov 8, 2020
9df8ddc
Edit diagram
Sruthisarav Nov 8, 2020
9743087
Fix grammatical error
Sruthisarav Nov 8, 2020
023701d
Merge branch 'master' into v1.4
Sruthisarav Nov 8, 2020
2ed0ad0
DG fix
rachel170 Nov 8, 2020
36be149
Edit DG
pengxiangg Nov 8, 2020
77aefb0
DG Effort changes
rachel170 Nov 8, 2020
5370105
Cut length of effort in DG
foongsq Nov 8, 2020
ba4c69f
Merge pull request #276 from pengxiangg/master
chuyouchia Nov 8, 2020
7c31822
DG Fix
rachel170 Nov 8, 2020
df0f73b
Merge branch 'master' into v1.4
chuyouchia Nov 8, 2020
4afc62a
Merge pull request #279 from Sruthisarav/v1.4
chuyouchia Nov 8, 2020
1433f35
Merge branch 'master' into master
chuyouchia Nov 8, 2020
6a3aed0
Merge branch 'master' into DG-update
chuyouchia Nov 8, 2020
d7876b1
Merge pull request #278 from rachel170/master
chuyouchia Nov 8, 2020
4cdda3f
Merge branch 'master' into DG-update
pengxiangg Nov 8, 2020
0089815
Merge pull request #280 from foongsq/DG-update
chuyouchia Nov 8, 2020
0deeb3a
Update AboutUs.md
chuyouchia Nov 8, 2020
a05db60
Edit page break
pengxiangg Nov 8, 2020
11006f0
Update chuyouchia.md
chuyouchia Nov 8, 2020
1e90511
Update UG page break
pengxiangg Nov 8, 2020
e97a9bc
Update chuyouchia.md
chuyouchia Nov 8, 2020
99f2f46
Update chuyouchia.md
chuyouchia Nov 8, 2020
7f1b932
Add page breaks
pengxiangg Nov 8, 2020
9f3c785
Update chuyouchia.md
chuyouchia Nov 8, 2020
629d3bb
Add page breaks
pengxiangg Nov 8, 2020
14beac9
Update chuyouchia.md
chuyouchia Nov 8, 2020
be761fc
Update chuyouchia.md
chuyouchia Nov 8, 2020
898e3b0
Update chuyouchia.md
chuyouchia Nov 8, 2020
cf87945
Add page break
pengxiangg Nov 8, 2020
a85ab31
Update chuyouchia.md
chuyouchia Nov 8, 2020
40349b5
Add page breaks
pengxiangg Nov 8, 2020
7e87896
Add blank line
pengxiangg Nov 8, 2020
587451d
Update chuyouchia.md
chuyouchia Nov 8, 2020
c251afe
Add break
pengxiangg Nov 8, 2020
59c4842
Update chuyouchia.md
chuyouchia Nov 8, 2020
7a669c4
Remove break
pengxiangg Nov 8, 2020
c08c237
Remove spacing
pengxiangg Nov 8, 2020
8725cf5
Add break
pengxiangg Nov 8, 2020
f2e394a
Add page break
pengxiangg Nov 8, 2020
dfde35c
Add page breaks
pengxiangg Nov 8, 2020
2854992
Add page breaks
pengxiangg Nov 8, 2020
aebf354
Combine to one line
pengxiangg Nov 8, 2020
4e003a9
Add page break
pengxiangg Nov 8, 2020
bdb3130
Add break
pengxiangg Nov 8, 2020
15b5425
Add page break
pengxiangg Nov 8, 2020
e2a7586
Add page break
pengxiangg Nov 8, 2020
a126976
Add page break
pengxiangg Nov 8, 2020
f650c0b
Add breaks
pengxiangg Nov 8, 2020
746f326
Add page break
pengxiangg Nov 8, 2020
9458492
Remove break
pengxiangg Nov 8, 2020
4fafb6a
Add page break
pengxiangg Nov 8, 2020
d921122
Add break
pengxiangg Nov 8, 2020
fcf892c
Add page break
pengxiangg Nov 8, 2020
bca3c0c
Add page breaks
pengxiangg Nov 8, 2020
7e3aada
Add page break
pengxiangg Nov 8, 2020
bef1b39
Add spacing
pengxiangg Nov 8, 2020
ae16be3
Add page break
pengxiangg Nov 8, 2020
0d24c67
Remove spacing
pengxiangg Nov 8, 2020
88cc1e0
Add page break
pengxiangg Nov 8, 2020
6fc0161
Add page break
pengxiangg Nov 8, 2020
dc49105
Add page break
pengxiangg Nov 8, 2020
2010ee0
Update javaDocs
chuyouchia Nov 8, 2020
65e866b
Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T15-2/tp
pengxiangg Nov 8, 2020
b1c7d47
Add page break
pengxiangg Nov 8, 2020
f7d76a1
Merge pull request #281 from pengxiangg/master
chuyouchia Nov 8, 2020
ac1e00f
Merge branch 'master' into update-javadocs
chuyouchia Nov 8, 2020
d060fac
Merge pull request #282 from chuyouchia/update-javadocs
pengxiangg Nov 8, 2020
6ea25e6
Update sruthisarav.md
Sruthisarav Nov 8, 2020
6f364d6
Update sruthisarav.md
Sruthisarav Nov 8, 2020
9935e26
Update foongsq.md
foongsq Nov 8, 2020
8ba132f
Merge pull request #284 from AY2021S1-CS2103T-T15-2/Sruthisarav-patch-3
foongsq Nov 8, 2020
2356c16
Merge branch 'master' into foongsq-PPP-patch
foongsq Nov 8, 2020
ab14216
Merge pull request #285 from AY2021S1-CS2103T-T15-2/foongsq-PPP-patch
foongsq Nov 8, 2020
bb8dccf
Update sruthisarav.md
Sruthisarav Nov 8, 2020
c4baeb6
Update foongsq.md
foongsq Nov 8, 2020
5b92f8f
Merge branch 'master' into Sruthisarav-ppp-patch
Sruthisarav Nov 8, 2020
f56ef57
Merge pull request #286 from AY2021S1-CS2103T-T15-2/Sruthisarav-ppp-p…
Sruthisarav Nov 8, 2020
d2e289b
Merge branch 'master' into foongsq-patch-1
foongsq Nov 8, 2020
9623ee2
Update sruthisarav.md
Sruthisarav Nov 8, 2020
e3b4337
Update sruthisarav.md
Sruthisarav Nov 8, 2020
db0d1a6
Update PPP line break
foongsq Nov 8, 2020
c4c9f4e
Merge pull request #287 from AY2021S1-CS2103T-T15-2/foongsq-patch-1
foongsq Nov 8, 2020
2aa5f27
Merge branch 'master' into Sruthisarav-ppp-patch-1
Sruthisarav Nov 8, 2020
7af276f
Merge pull request #288 from AY2021S1-CS2103T-T15-2/Sruthisarav-ppp-p…
Sruthisarav Nov 8, 2020
a99f566
Update sruthisarav.md
Sruthisarav Nov 8, 2020
73ebebd
Merge pull request #290 from AY2021S1-CS2103T-T15-2/Sruthisarav-ppp-p…
Sruthisarav Nov 8, 2020
dfc56a2
Merge branch 'master' into sqpatch
foongsq Nov 8, 2020
960d6b5
Merge branch 'master' into sqpatch
foongsq Nov 8, 2020
b06223f
Merge pull request #289 from foongsq/sqpatch
foongsq Nov 8, 2020
ec314e1
Update foongsq.md
foongsq Nov 8, 2020
d8b7ad3
Merge pull request #291 from AY2021S1-CS2103T-T15-2/foongsq-patch-2
foongsq Nov 8, 2020
97a3ba3
Update foongsq.md
foongsq Nov 8, 2020
483b991
Merge pull request #292 from AY2021S1-CS2103T-T15-2/foongsq-patch-3
foongsq Nov 8, 2020
9736a2e
Update foongsq.md
foongsq Nov 8, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ src/main/resources/docs/
/.idea/
/out/
/*.iml
*.iml

# Storage/log files
/data/
Expand Down
Empty file added LogicManager
Empty file.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![CI Status](https://github.com/AY2021S1-CS2103T-T15-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-T15-2/tp/actions)
[![codecov](https://codecov.io/gh/AY2021S1-CS2103T-T15-2/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103T-T15-2/tp)

![Ui](docs/images/Ui.png)

* This is **a sample project for Software Engineering (SE) students**.<br>
Example usages:
* as a starting point of a course project (as opposed to writing everything from scratch)
* as a case study
* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
* This project simulates an ongoing software project for a desktop application (called _FlashNotes_) used for managing flashcards.
* It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
* It comes with a **reasonable level of user and developer documentation**.
* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
* For the detailed documentation of this project, see the **[Flash Notes Product Website](https://ay2021s1-cs2103t-t15-2.github.io/tp/) **.
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org) If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
8 changes: 6 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ plugins {
id 'jacoco'
}

mainClassName = 'seedu.address.Main'
mainClassName = 'seedu.flashnotes.Main'

sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
Expand Down Expand Up @@ -66,7 +66,11 @@ dependencies {
}

shadowJar {
archiveName = 'addressbook.jar'
archiveName = 'flashnotes.jar'
}

defaultTasks 'clean', 'test'

run {
enableAssertions = true
}
21 changes: 8 additions & 13 deletions config/checkstyle/checkstyle.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">

<!--
This configuration file enforces rules for a modified version of the module's code standard at
Expand Down Expand Up @@ -56,11 +56,11 @@
4. THIRD_PARTY_PACKAGE: defined as com imports
-->
<module name="CustomImportOrder">
<property name="customImportOrderRules"
value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
<property name="specialImportsRegExp" value="^org\."/>
<property name="thirdPartyPackageRegExp" value="^com\."/>
<property name="sortImportsInGroupAlphabetically" value="true"/>
<property name="customImportOrderRules"
value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
<property name="specialImportsRegExp" value="^org\."/>
<property name="thirdPartyPackageRegExp" value="^com\."/>
<property name="sortImportsInGroupAlphabetically" value="true"/>
</module>

<!-- Checks for redundant import statements.
Expand Down Expand Up @@ -188,13 +188,10 @@
<module name="NeedBraces">
<!--
if (true) return 1; // Not allowed

if (true) { return 1; } // Not allowed

else if {
return 1; // else if should always be multi line
}

if (true)
return 1; // Not allowed
-->
Expand All @@ -216,7 +213,7 @@
some other variants which we don't publicized to promote consistency).
-->
<property name="reliefPattern"
value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
</module>

<module name="MissingSwitchDefault"/>
Expand Down Expand Up @@ -359,14 +356,12 @@
-->
<module name="SingleSpaceSeparator">
<!-- Validate whitespace surrounding comments as well.

a = 1; // Allowed (single space before start of comment)
a = 1; /* Allowed (single space before start of comment) */
/* Allowed (single space after end of comment) */ a = 1;
a = 1; // Not allowed (more than one space before start of comment)
a = 1; /* Not allowed (more than one space before start of comment) */
/* Not allowed (more than one space after end of comment) */ a = 1;

This doesn't validate whitespace within comments so a comment /* like this */ is allowed.
-->
<property name="validateComments" value="true"/>
Expand Down
62 changes: 31 additions & 31 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,55 +5,55 @@ title: About Us

We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).

You can reach us at the email `seer[at]comp.nus.edu.sg`

## Project team

### John Doe
### Jacob Chia Chu You

<img src="images/johndoe.png" width="200px">
<img src="images/chuyouchia.png" width="200px">

[[homepage](http://www.comp.nus.edu.sg/~damithch)]
[[github](https://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://github.com/chuyouchia)]
[[portfolio](team/chuyouchia.md)]

* Role: Project Advisor
* Role: Team Lead
* Responsibilities: UI

### Jane Doe
### Foong Siqi

<img src="images/johndoe.png" width="200px">
<img src="images/foongsq.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://github.com/foongsq)]
[[portfolio](team/foongsq.md)]

* Role: Team Lead
* Responsibilities: UI
* Role: Deliverables and Deadlines
* Responsibilities: Ensure project deliverables are done on time and in the right format.

### Johnny Doe
### Sruthi Saravanan

<img src="images/johndoe.png" width="200px">
<img src="images/sruthisarav.png" width="200px">

[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
[[github](http://github.com/Sruthisarav)]
[[portfolio](team/sruthisarav.md)]

* Role: Developer
* Responsibilities: Data
* Role: Documentation
* Responsibilities: Responsible for the quality of various project documents.

### Jean Doe
### Peng Xiang

<img src="images/johndoe.png" width="200px">
<img src="images/pengxiangg.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://https://github.com/pengxiangg)]
[[portfolio](team/pengxiangg.md)]

* Role: Developer
* Responsibilities: Dev Ops + Threading
* Role: Integration
* Responsibilities: In charge of versioning of the code, maintaining the code repository,
integrating various parts of the software to create a whole.

### James Doe
### Rachel Ho Xin Ying

<img src="images/johndoe.png" width="200px">
<img src="images/rachel170.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://github.com/rachel170)]
[[portfolio](team/rachel170.md)]

* Role: Developer
* Responsibilities: UI
* Role: Testing
* Responsibilities: Ensures the testing of the project is done properly and on time.
21 changes: 0 additions & 21 deletions docs/DevOps.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,27 +46,6 @@ As part of CI, this project uses Codecov to generate coverage reports. Here are
1. Once you are inside Codecov web app, add your fork to CodeCov.
1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.

### Repository-wide checks

In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.

These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:

`./config/travis/run-checks.sh`

Any warnings or errors will be printed out to the console.

**If adding new checks:**

* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.

* Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE`
* SEVERITY is either ERROR or WARN.
* FILENAME is the path to the file relative to the current directory.
* LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.

* Check scripts must exit with a non-zero exit code if any errors occur.

--------------------------------------------------------------------------------------------------------------------

## Making a release
Expand Down
Loading