diff --git a/README.adoc b/README.adoc index e08acef48087..a542afe48ba4 100644 --- a/README.adoc +++ b/README.adoc @@ -14,13 +14,12 @@ 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. -* 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. +* This is a desktop OurTeeth application. It has a GUI but most of the user interactions happen using a CLI (Command +Line Interface). +* Targeted towards Dentists who prefer to type. +* It is developed in Java through the efforts of a five man team from NUS +* It is *written in OOP fashion*. + == Site Map diff --git a/docs/AboutUs.adoc b/docs/AboutUs.adoc index bf8ca564003e..ba9c9857dd97 100644 --- a/docs/AboutUs.adoc +++ b/docs/AboutUs.adoc @@ -4,53 +4,60 @@ :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.}_ + +OurTeeth was developed by the W17-02 Team + +The basis of our product, AddressBook - Level 4, was developed by the https://se-edu.github.io/docs/Team.html[se-edu] +team. + {empty} + We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore]. == Project Team +{nbsp} + -=== John Doe -image::damithc.jpg[width="150", align="left"] -{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<>] +image::kylerwsm.png[width="150", align="left"] +{nbsp} + +*Kyler Wong Shen Meng*,{nbsp} _Developer / Tester_ {nbsp}{nbsp}{nbsp}{nbsp}{nbsp}``https://github.com/kylerwsm[GitHub]``{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}``<>`` +{nbsp} + +{nbsp} + -Role: Project Advisor +Responsibilities:: +* Build efficient data structures that stores represented dental data +* Develop dentistry-specific functions and features +* Ensure intuitiveness of dentistry data to dentist users +* Apply and conform to renowned dentistry standards ''' -=== John Roe -image::lejolly.jpg[width="150", align="left"] -{empty}[http://github.com/lejolly[github]] [<>] +=== Keith Sim +image::kthsim.png[width="150", align="left"] +{empty}[https://github.com/kthSim[github]] [<>] -Role: Team Lead + -Responsibilities: UI +Role: Developer + +Responsibilities: Records Managament ''' -=== Johnny Doe -image::yijinl.jpg[width="150", align="left"] -{empty}[http://github.com/yijinl[github]] [<>] +=== Lim Jia Hao +image::jiahaolim.png[width="150", align="left"] +{empty}[https://github.com/JiaHaoLim[github]] [<>] Role: Developer + -Responsibilities: Data +Responsibilities: Records IO ''' -=== Johnny Roe -image::m133225.jpg[width="150", align="left"] -{empty}[http://github.com/m133225[github]] [<>] +=== Jonathan Choo +image::cchj1995.jpg[width="150", align="left"] +{empty}[http://github.com/cchj1995[github]] [<>] Role: Developer + -Responsibilities: Dev Ops + Threading +Responsibilities: Login ''' -=== Keith Sim -image::kthSim.png[width="150", align="left"] -{empty}[https://github.com/kthSim[github]] [<>] +=== Wang Debang +image::wsemis.JPG[width="150", aligh="left"] +{empty}[https://github.com/wSemis[github]] [<>] Role: Developer + -Responsibilities: Records Managament - -''' +Responsibilities: Record processing diff --git a/docs/ContactUs.adoc b/docs/ContactUs.adoc index 5de5363abffd..3f980fc81c0c 100644 --- a/docs/ContactUs.adoc +++ b/docs/ContactUs.adoc @@ -2,6 +2,6 @@ :site-section: ContactUs :stylesDir: stylesheets -* *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. +* *Bug reports, Suggestions* : Post in our https://github.com/cs2103-ay1819s2-w17-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 `e0176930@u.nus.edu (Keith Sim)` or `kylerwong@u.nus.edu (Kyler Wong)` diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index e99101f8650d..10200578100c 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -1,4 +1,4 @@ -= AddressBook Level 4 - User Guide += OurTeeth - User Guide :site-section: UserGuide :toc: :toc-title: @@ -14,11 +14,12 @@ ifdef::env-github[] endif::[] :repoURL: https://github.com/se-edu/addressbook-level4 -By: `Team SE-EDU` Since: `Jun 2016` Licence: `MIT` +By: `Team W17-2` Since: `Feb 2019` Licence: `MIT` == Introduction -AddressBook Level 4 (AB4) is for those who *prefer to use a desktop app for managing contacts*. More importantly, AB4 is *optimized for those who prefer to work with a Command Line Interface* (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB4 can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the <> to get started. Enjoy! +OurTeeth is for dentists who *prefer to use a desktop app for managing patient records*. More importantly, + AB4 is *optimized for those who prefer to work with a Command Line Interface* (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB4 can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the <> to get started. Enjoy! == Quick Start diff --git a/docs/images/Ui.png b/docs/images/Ui.png index 5ec9c527b49c..dad5c66e7f8b 100644 Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ diff --git a/docs/images/cchj1995.jpg b/docs/images/cchj1995.jpg new file mode 100644 index 000000000000..55301123aea2 Binary files /dev/null and b/docs/images/cchj1995.jpg differ diff --git a/docs/images/jiahaolim.png b/docs/images/jiahaolim.png new file mode 100644 index 000000000000..827256e994a5 Binary files /dev/null and b/docs/images/jiahaolim.png differ diff --git a/docs/images/kthSim.png b/docs/images/kthsim.png similarity index 100% rename from docs/images/kthSim.png rename to docs/images/kthsim.png diff --git a/docs/images/kylerwsm.png b/docs/images/kylerwsm.png new file mode 100644 index 000000000000..0a5e9637f501 Binary files /dev/null and b/docs/images/kylerwsm.png differ diff --git a/docs/images/wsemis.JPG b/docs/images/wsemis.JPG new file mode 100644 index 000000000000..c226cdac59aa Binary files /dev/null and b/docs/images/wsemis.JPG differ diff --git a/docs/team/kylerwsm.adoc b/docs/team/kylerwsm.adoc new file mode 100644 index 000000000000..c870bed3031f --- /dev/null +++ b/docs/team/kylerwsm.adoc @@ -0,0 +1,72 @@ += Kyler Wong - Project Portfolio +:site-section: AboutUs +:imagesDir: ../images +:stylesDir: ../stylesheets + +== PROJECT: AddressBook - Level 4 + +--- + +== Overview + +AddressBook - Level 4 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +== Summary of contributions + +* *Major enhancement*: added *the ability to undo/redo previous commands* +** What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command. +** Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them. +** Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands. +** Credits: _{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}_ + +* *Minor enhancement*: added a history command that allows the user to navigate to previous commands using up/down keys. + +* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_ + +* *Other contributions*: + +** Project management: +*** Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub +** Enhancements to existing features: +*** Updated the GUI color scheme (Pull requests https://github.com[#33], https://github.com[#34]) +*** Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests https://github.com[#36], https://github.com[#38]) +** Documentation: +*** Did cosmetic tweaks to existing contents of the User Guide: https://github.com[#14] +** Community: +*** PRs reviewed (with non-trivial review comments): https://github.com[#12], https://github.com[#32], https://github.com[#19], https://github.com[#42] +*** Contributed to forum discussions (examples: https://github.com[1], https://github.com[2], https://github.com[3], https://github.com[4]) +*** Reported bugs and suggestions for other teams in the class (examples: https://github.com[1], https://github.com[2], https://github.com[3]) +*** Some parts of the history feature I added was adopted by several other class mates (https://github.com[1], https://github.com[2]) +** Tools: +*** Integrated a third party library (Natty) to the project (https://github.com[#42]) +*** Integrated a new Github plugin (CircleCI) to the team repo + +_{you can add/remove categories in the list above}_ + +== Contributions to the User Guide + + +|=== +|_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._ +|=== + +include::../UserGuide.adoc[tag=undoredo] + +include::../UserGuide.adoc[tag=dataencryption] + +== Contributions to the Developer Guide + +|=== +|_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._ +|=== + +include::../DeveloperGuide.adoc[tag=undoredo] + +include::../DeveloperGuide.adoc[tag=dataencryption] + + +== PROJECT: PowerPointLabs + +--- + +_{Optionally, you may include other projects in your portfolio.}_