Skip to content

Commit

Permalink
Merge pull request #1 from cs2103-ay1819s2-w17-2/master
Browse files Browse the repository at this point in the history
v1.1 Update of local repository with main
  • Loading branch information
JiaHaoLim authored Mar 8, 2019
2 parents addfa47 + 31cf1af commit 12226f4
Show file tree
Hide file tree
Showing 40 changed files with 1,636 additions and 203 deletions.
19 changes: 10 additions & 9 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
= Address Book (Level 4)
= OurTeeth (Morphed from Address Book Level 4)
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]]


ifdef::env-github[]
image::docs/images/Ui.png[width="600"]
Expand All @@ -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

Expand All @@ -32,6 +31,8 @@ endif::[]

== Acknowledgements

* This application uses the base https://github.com/se-edu/addressbook-level4[AddressBook 4] created by
_NUS se-edu team_.
* 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://github.com/TestFX/TestFX[TextFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
Expand Down
57 changes: 32 additions & 25 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]] [<<johndoe#, portfolio>>]
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}``<<johndoe#, Portfolio>>``
{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]] [<<johndoe#, portfolio>>]
=== Keith Sim
image::kthsim.png[width="150", align="left"]
{empty}[https://github.com/kthSim[github]] [<<johndoe#, portfolio>>]

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]] [<<johndoe#, portfolio>>]
=== Lim Jia Hao
image::jiahaolim.png[width="150", align="left"]
{empty}[https://github.com/JiaHaoLim[github]] [<<johndoe#, portfolio>>]

Role: Developer +
Responsibilities: Data
Responsibilities: Records IO

'''

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

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

'''

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

Role: Developer +
Responsibilities: UI

'''
Responsibilities: Record processing
4 changes: 2 additions & 2 deletions docs/ContactUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 `[email protected] (Keith Sim)` or `kylerwong@u.nus.edu (Kyler Wong)`
8 changes: 8 additions & 0 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -837,6 +837,14 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un

|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident

|`* *` |user |copy a person |reduce the time needed to create a new person who has similar records to an existing person in the list

|`* *` |user |export entries into an external file |view certain entries even when I am not using the application

|`* *` |user |import entries from an external file |reduce the time needed to create a person whose information can be already be obtained from an external source

|`*` |user with confidential patient information|log into the application with a password |prevent unauthorized access to the application when I am not around

|`*` |user with many persons in the address book |sort persons by name |locate a person easily
|=======================================================================

Expand Down
Loading

0 comments on commit 12226f4

Please sign in to comment.