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

Report generation module completed #177

Open
wants to merge 24 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ src/test/data/sandbox/

# MacOS custom attributes files created by Finder
.DS_Store

# Do not add docs folder
34 changes: 26 additions & 8 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
= Address Book (Level 3)
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://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/AY1920S2-CS2103T-W15-1/main.svg?branch=master[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://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]]

Expand All @@ -15,9 +14,28 @@ 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.
*Contact Tracing App*
****
Contact Tracing APP is a efficient and lightweight tool for contact tracing for government managers and individual users.
This will help you save countless hours by collecting contact data and generate report automatically. Besides, this application provides a great privacy protect system to prevent privacy leak.
Worring about your health and want to know whether the area you live is safe now? Don't hesitate and start to try this app now!
****

*Who is it for?*
*****
- The government managers who want to get informantion about epidemic situation for their decision making.
- All citizens who want to know the situation of the spread of virus.
- Database developers who are working for collecting and managing the information about virus spreeading.
*****

*Features*
****
- Generate detailed reports from the app with several clicks.
- Identify anonymous individuals who are highly connected within the society for senior government officer.
- Identify hotpots where people tend to grather within the society.
- Individual users can get access with their personal information including citizenship ID, name, etc.
****


== Site Map

Expand All @@ -29,8 +47,8 @@ endif::[]

== 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]

== Licence : link:LICENSE[MIT]



1 change: 1 addition & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ dependencies {
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion

testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
compile fileTree(dir:'libs',include:['*.jar'])
}

shadowJar {
Expand Down
52 changes: 13 additions & 39 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,27 @@
: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} +
We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
Covid-19 contact tracing App - 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>>]

Role: Project Advisor

'''

=== John Roe
image::lejolly.jpg[width="150", align="left"]
{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
This app was developed as an extension to AddressBook Level 3 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team.

Role: Team Lead +
Responsibilities: UI

'''
== Project Team

=== Johnny Doe
image::yijinl.jpg[width="150", align="left"]
{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
=== Johan Kok
image::johankok.png[width="150", align="left"]
{empty}[http://www.johankzk.com/[homepage]] [https://github.com/JKOK005[github]]

Role: Developer +
Responsibilities: Data
Role: Minion
Responsibilities: UI + Backend

'''

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

Role: Developer +
Responsibilities: Dev Ops + Threading
Role: Minion
Responsibilities: UI + Backend

'''

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

Role: Developer +
Responsibilities: UI

'''
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-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S2-CS2103-W15-1/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 `johan.kok@u.nus.edu`
Loading