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-F12-3] Tagline #111

Open
wants to merge 131 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
131 commits
Select commit Hold shift + click to select a range
f8be591
Update AboutUs.adoc for team members to commit (#2)
tanlk99 Sep 30, 2019
70fce5c
Merge pull request #1 from AY1920S1-CS2103T-F12-3/master
e0031374 Sep 30, 2019
acfadab
Adds About Us for Yehezkiel
Yehezkiel01 Sep 30, 2019
2f876ee
Merge pull request #3 from Yehezkiel01/master
tanlk99 Sep 30, 2019
6a70cd6
Refactor package name from 'seedu.address' to 'tagline'
stevenwjy Sep 30, 2019
61ba584
Update Developer Guide
tanlk99 Sep 30, 2019
a1b7357
[Shiwei] Update About Us team member detail (#5)
shiweing Sep 30, 2019
1d4aed9
Merge branch 'refactor-package-name'
stevenwjy Sep 30, 2019
7616a00
Refactor package name from 'seedu.address' to 'tagline' (#6)
stevenwjy Sep 30, 2019
1641cc5
Update mainClassName in build.gradle
stevenwjy Sep 30, 2019
9e47773
Merge pull request #2 from AY1920S1-CS2103T-F12-3/master
stevenwjy Sep 30, 2019
2b28749
Merge pull request #7 from stevenwjy/master
e0031374 Sep 30, 2019
6d34a14
Merge pull request #2 from AY1920S1-CS2103T-F12-3/master
e0031374 Sep 30, 2019
12c7eec
added aboutus details
e0031374 Sep 30, 2019
069fba5
Merge pull request #8 from e0031374/master
shiweing Oct 1, 2019
f9eab62
Update UG: Contact Command + Basic Commands (#24)
e0031374 Oct 3, 2019
c8d9b97
Update mentions of AddressBook to TagLine (#25)
tanlk99 Oct 3, 2019
963e867
Update UG: note command (#26)
Yehezkiel01 Oct 3, 2019
6cd46fa
Update About Us (#27)
Yehezkiel01 Oct 3, 2019
4349e1e
Updates contact us (#28)
Yehezkiel01 Oct 3, 2019
099ff56
Update user guide #12 (#29)
shiweing Oct 3, 2019
79063c4
Update README.adoc intro (#30)
Yehezkiel01 Oct 3, 2019
a3d4f6a
Update UG: Intro, Quick Start, Command Format, and Tag (#32)
stevenwjy Oct 3, 2019
ba32383
Update README (#31)
shiweing Oct 3, 2019
5168b82
Update about us (#33)
stevenwjy Oct 3, 2019
45593b2
Update travis build status in README.adocs (#34)
stevenwjy Oct 3, 2019
64d40f8
Update Prof name in AboutUs (#35)
shiweing Oct 3, 2019
08c2341
Rename Yehezkiel image (#36)
Yehezkiel01 Oct 3, 2019
a55d673
Fix typos in Developer Guide and User Guide (#37)
tanlk99 Oct 3, 2019
abe7585
Add chat pane to GUI (#9)
tanlk99 Oct 8, 2019
347d3dd
Refactor result pane view (#42)
tanlk99 Oct 9, 2019
def9c5f
Implement view switching in GUI (#46)
tanlk99 Oct 9, 2019
35fc775
Refactor Contact Command Parsers (#43)
stevenwjy Oct 10, 2019
6d08747
Update contact parser (#62)
stevenwjy Oct 10, 2019
554ef38
Rename person to contact (#65)
Yehezkiel01 Oct 11, 2019
998f7e1
Add GUI tests with TestFX (#67)
tanlk99 Oct 14, 2019
5b09f7b
Fix buggy interface in headed GUI test (#76)
tanlk99 Oct 15, 2019
9d02805
Implement create note command (#51)
shiweing Oct 16, 2019
ae5c858
Removed Unneeded Notes Test Data (#79)
e0031374 Oct 16, 2019
9efdc3b
Refactor contact model (#68)
Yehezkiel01 Oct 16, 2019
b510bea
Create view to display notes (#78)
tanlk99 Oct 16, 2019
bb9b3ae
Implement tag manager (#72)
tanlk99 Oct 17, 2019
b240c4e
Integrate GUI, Contact, Note and Storage components (#83)
tanlk99 Oct 17, 2019
26b8aa5
Update EditContact and DeleteContact commands to use ContactId (#84)
Yehezkiel01 Oct 17, 2019
398200b
Implement list note command (#82)
shiweing Oct 17, 2019
61d7d83
Fix ContactListCard (#86)
tanlk99 Oct 17, 2019
1c86433
Fix EditNoteCommand (#95)
tanlk99 Oct 17, 2019
2b27780
Implement validation for note content (#96)
shiweing Oct 17, 2019
6497c37
Update team roles (#98)
stevenwjy Oct 17, 2019
d201ae5
Refactor tag structure and set baseline for tag (#80)
stevenwjy Oct 17, 2019
28621c8
Fix Broken Startup (#101)
tanlk99 Oct 17, 2019
f79e946
Add DeleteNoteCommandTest (#107)
shiweing Oct 20, 2019
bd3c2e5
Refactor TagList to follow structure (#109)
tanlk99 Oct 22, 2019
1773efd
Update architecture diagrams, UI structure, user stories, use cases a…
tanlk99 Oct 23, 2019
8998f06
Include User Prompt feature in DG (#114)
tanlk99 Oct 23, 2019
6ac74cc
Added Class Diagrams for NoteModel, Storage, StorageModel to DG and f…
e0031374 Oct 23, 2019
194d369
Update Logic and NoteLogic in DG (#116)
shiweing Oct 23, 2019
d244a18
Fix wrong UiClassDiagram.png (#117)
shiweing Oct 23, 2019
1bbce3f
Fix UiClassDiagram and ArchitectureSequenceDiagram (#119)
tanlk99 Oct 23, 2019
d09808a
Update developer guide for Contact Model and Contact storage componen…
Yehezkiel01 Oct 23, 2019
13a3a8f
Update sample images in the user guide (#122)
stevenwjy Oct 24, 2019
bd4ce85
Update DG: Contact Logic Component (#121)
stevenwjy Oct 24, 2019
513dbbb
Update Dev Guide for Proposed Feature (#120)
e0031374 Oct 24, 2019
3d030d5
Added Group Support in ModelManager, StorageManager, Tests (#105)
e0031374 Oct 24, 2019
84121db
Update Dev Guide Proposed Component (#123)
e0031374 Oct 24, 2019
4e8c5d8
Refactor ResultPane into a separate class (#103)
tanlk99 Oct 24, 2019
fd6ed89
Add note filtering implementation to DG (#124)
shiweing Oct 24, 2019
11d694a
Update note filtering sequence diagram in DG (#129)
shiweing Oct 25, 2019
8e555cc
Add tagging implementation to developer guide (#131)
Yehezkiel01 Oct 25, 2019
c114f13
Add tests fro delete note command (#133)
shiweing Oct 26, 2019
25d5c33
Add tests for edit note command (#134)
shiweing Oct 26, 2019
908591f
Added some XML for Dev Guide (#136)
e0031374 Oct 27, 2019
3d271df
Implement Group Features (#135)
e0031374 Oct 27, 2019
5e4cf59
Add views to display groups (#138)
tanlk99 Oct 30, 2019
471785b
Made Groups RepoSense Compatible for wk12 (#142)
e0031374 Oct 30, 2019
d29c596
Implement autocomplete feature (#125)
tanlk99 Oct 30, 2019
742c1f2
Update tag storage and contact tag (#141)
stevenwjy Oct 30, 2019
deffb1c
Fix truncated text in single group result view (#143)
tanlk99 Oct 30, 2019
2693615
Remove tag id
stevenwjy Oct 30, 2019
726b397
Update SampleDataUtil and One Potential Bug/fix (#153)
e0031374 Oct 31, 2019
c710891
Add ClearNoteCommand (#152)
shiweing Oct 31, 2019
9fc98b0
Add HashTag (#137)
Yehezkiel01 Oct 31, 2019
f94ebd1
Update various GUI components (#144)
tanlk99 Oct 31, 2019
512317d
Add group tag (#146)
stevenwjy Oct 31, 2019
ef2cf74
Implement note filtering (#140)
shiweing Oct 31, 2019
4e02111
Add tag list GUI and refactor some test files (#147)
stevenwjy Oct 31, 2019
0679445
Fix tag GUI and tag storage (#156)
Yehezkiel01 Oct 31, 2019
3ddb311
Add contact show command (#155)
stevenwjy Oct 31, 2019
4d0876c
Add user prompting feature (#150)
tanlk99 Oct 31, 2019
9e6b55c
Update diagram's xml and User Guide (#158)
Yehezkiel01 Oct 31, 2019
db4cde4
Dev Guide, User Guide Update and PPP (#151)
e0031374 Oct 31, 2019
f98002e
Add validation before parsing ContactTag and GroupTag (#160)
stevenwjy Oct 31, 2019
da5d81b
Implement minor GUI tweaks (#159)
tanlk99 Oct 31, 2019
435eeb2
Hashtag validation (#161)
Yehezkiel01 Oct 31, 2019
7b7d15e
Change version number to v1.3.0 (#163)
tanlk99 Oct 31, 2019
55718ee
Update user guide to include user-friendliness features (#165)
tanlk99 Nov 1, 2019
4c4a77e
Fix a variety of UI-related issues (#221)
tanlk99 Nov 4, 2019
963ce69
Ensure singular prefixes are only used once (#222)
shiweing Nov 4, 2019
d0615c0
Add support for tag prefix in CreateNoteCommand (#223)
shiweing Nov 5, 2019
c319181
Add full prompt functionality, refactor tests and add GUI listener (#…
tanlk99 Nov 5, 2019
c11dd5f
Update sample data (#225)
shiweing Nov 6, 2019
19768ea
Update UG note segment (#226)
shiweing Nov 6, 2019
189a86f
Update UI and prompting sections in DG (#228)
tanlk99 Nov 7, 2019
f25e854
Fix disabled autocomplete when aborting prompt (#230)
tanlk99 Nov 7, 2019
9c05ea0
Create PPP (#231)
tanlk99 Nov 7, 2019
e1d5ec5
Fix an endline (#232)
tanlk99 Nov 7, 2019
787e2d8
Update note filter in DG and show all notes after note delete (#234)
shiweing Nov 8, 2019
719db90
Add PPP for shiweing (#236)
shiweing Nov 10, 2019
f3c2c6e
Refactor parsers and add tests (#235)
tanlk99 Nov 10, 2019
293983f
Update PPP (#237)
shiweing Nov 10, 2019
2f0a501
Resolve some UG issues (#227)
stevenwjy Nov 10, 2019
c8876ef
Update link in AboutUs (#239)
tanlk99 Nov 10, 2019
ef64990
Check invalid tag (#241)
stevenwjy Nov 10, 2019
6e2e10c
Compress images slightly to fit PPP page limit (#240)
tanlk99 Nov 11, 2019
2ccbf15
Update UG to match product (#245)
Yehezkiel01 Nov 11, 2019
91677bf
Update contact show (#242)
stevenwjy Nov 11, 2019
de7b45e
Note tag bugfix (#244)
Yehezkiel01 Nov 11, 2019
c660b93
Fix bug saving tagbook (#247)
stevenwjy Nov 11, 2019
0c64247
UG and PPP Update (#238)
e0031374 Nov 11, 2019
bd8f22b
Fix sync issue (#248)
tanlk99 Nov 11, 2019
eec4082
Update manual testing (#249)
tanlk99 Nov 11, 2019
572b1ff
Update manual testing (#250)
e0031374 Nov 11, 2019
2a36e39
Update UG for PPP (#246)
Yehezkiel01 Nov 11, 2019
e727a5a
Update PPP screenshot (#251)
tanlk99 Nov 11, 2019
3c14593
Add manual tests for note commands in DG (#252)
shiweing Nov 11, 2019
5aeeddb
Update Tagging DG (#253)
Yehezkiel01 Nov 11, 2019
3594a66
Add command summary to UG (#254)
shiweing Nov 11, 2019
7cb487a
Create Yehezkiel PPP (#255)
Yehezkiel01 Nov 11, 2019
51eb56f
Update UG, DG, and PPP (#243)
stevenwjy Nov 11, 2019
cea6e8d
Update version number (#256)
tanlk99 Nov 11, 2019
0870455
Fix oversized images (#257)
tanlk99 Nov 11, 2019
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 @@ -10,6 +10,7 @@ src/main/resources/docs/

# Storage/log files
/data/
/src/test/data/JsonNoteBookStorageTest/TempNoteBook2.json
/config.json
/preferences.json
/*.log.*
Expand Down
14 changes: 13 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,21 @@ matrix:
include:
- jdk: openjdk11

services:
- xvfb

before_install:
- sudo apt update
- sudo apt install openjfx
- chmod +x ./gradlew
- export DISPLAY=:99.0

install: true

script: >-
./config/travis/run-checks.sh &&
./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
./gradlew clean checkstyleMain checkstyleTest headless test &&
./gradlew test coverage coveralls asciidoctor

deploy:
skip_cleanup: true
Expand Down
23 changes: 13 additions & 10 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
= Address Book (Level 3)
= TagLine
ifdef::env-github,env-browser[:relfileprefix: docs/]

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

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

* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
== About TagLine
Tired of Sticky Notes? +
Having trouble finding the right note in your messy collage of notes? +
Want a CLI note-taking app befitting of the techie that you are?

TagLine is just for you!

Being a multi-purpose note-taking app, not only can you take notes from the command line, you can also tag your notes with hashtags, contacts or groups. Managing your notes have never been easier!

== Site Map

* <<UserGuide#, User Guide>>
* <<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_.
* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
* The original source of the code was created by SE-EDU initiative at https://se-education.org
* Libraries used: https://openjfx.io/[JavaFX], https://github.com/controlsfx/controlsfx[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5], https://github.com/TestFX/TestFX[TestFX], http://github.com/https://github.com/hamcrest/JavaHamcrest[Hamcrest]

== Licence : link:LICENSE[MIT]
33 changes: 28 additions & 5 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ plugins {
}

// Specifies the entry point of the application
mainClassName = 'seedu.address.Main'
mainClassName = 'tagline.Main'

sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
Expand Down Expand Up @@ -60,15 +60,19 @@ dependencies {

implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
implementation group: 'org.controlsfx', name: 'controlsfx', version: '11.0.0'
testCompile group: 'org.testfx', name: 'testfx-core', version: '4.0.16-alpha'
testCompile group: 'org.testfx', name: 'testfx-junit5', version: '4.0.16-alpha'
testCompile group: 'org.hamcrest', name: 'hamcrest', version: '2.1'

testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion

testRuntimeOnly "org.testfx:openjfx-monocle:jdk-11+26"
testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
}

shadowJar {
archiveName = 'addressbook.jar'

archiveName = 'tagline.jar'
destinationDir = file("${buildDir}/jar/")
}

Expand Down Expand Up @@ -114,6 +118,25 @@ test {
}
}

task headless {
doLast {
println 'Setting headless mode properties.'
test {
systemProperties = [
'java.awt.headless': 'true',
'testfx.robot': 'glass',
'testfx.headless': 'true',
'prism.order': 'sw',
'prism.text': 't2k',
'headless.geometry': '1600x1200-32'
]
}
}
}

// Makes sure that headless properties are set before running tests
test.mustRunAfter headless

asciidoctor {
backends 'html5'
sourceDir 'docs'
Expand All @@ -133,8 +156,8 @@ asciidoctor {
idprefix: '', // for compatibility with GitHub preview
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-name': 'tagline',
'site-githuburl': 'https://github.com/AY1920S1-CS2103T-F12-3/main',
'site-seedu': true, // delete this line if your project is not a fork (not a SE-EDU project)
]

Expand Down
64 changes: 40 additions & 24 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,69 @@
: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} +
TagLine was developed by the https://AY1920S1-CS2103T-F12-3.github.io/docs/Team.html[AY1920-F12-3] 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
=== Prof. Damith C. Rajapakse
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

'''

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

Role: Team Lead +
Responsibilities: UI
Roles:

- Team Lead
- In charge of UI
- In charge of tag model.

'''

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

Roles:

Role: Developer +
Responsibilities: Data
- Testing
- In charge of note logic

'''

=== Johnny Roe
image::m133225.jpg[width="150", align="left"]
{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
=== Ng Shi Wei
image::shiweing.png[width="150", align="left"]
{empty}[https://github.com/shiweing[github]] [<<shiweing#, portfolio>>]

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

- Documentation
- In charge of note model

'''

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

Roles:

Role: Developer +
Responsibilities: UI
- Quality Assurance
- In charge of contact logic

'''

=== Yehezkiel Raymundo Theodoroes
image::yehezkiel01.png[width="150", align="left"]
{empty}[https://github.com/Yehezkiel01[github]] [<<yehezkiel01#, portfolio>>]

Roles:

- Scheduling and tracking
- In charge of contact model
4 changes: 1 addition & 3 deletions docs/ContactUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@
: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.
* *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`
* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S1-CS2103T-F12-3/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
4 changes: 2 additions & 2 deletions docs/DevOps.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= AddressBook Level 3 - Dev Ops
= TagLine - Dev Ops
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand All @@ -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/AY1920S1-CS2103T-F12-3/main/tree/master

== Build Automation

Expand Down
Loading