[T08-4] FOP Manager

.gitignore

@@ -17,4 +17,5 @@ classes/
 /data/
 /bin/
 src/main/resources/docs/
+chart/
 out/

CODEOWNERS

@@ -0,0 +1,8 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*       @weizhang05 @tantantan277 @shanseet

README.adoc

@@ -1,10 +1,7 @@
-= Address Book (Level 4)
+= FOP Manager
 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]]
+https://travis-ci.org/CS2113-AY1819S2-T08-4/main[image:https://travis-ci.org/CS2113-AY1819S2-T08-4/main.svg?branch=master[Build Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,25 +12,27 @@ 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.
+* It is a Java application targeted at *Project Directors* organizing the *School of Computing Freshman Orientation Camp*.
+* This application is a useful tool to manage the contacts of participating Freshmen, OGLs and others. Its features include:
+** An easy to use GUI with a list panel displaying participant details
+** Listing of participants by their 3 categories (Freshmen, OGLs and others)
+** Grouping of participants into groups, stored within houses
+** Viewing graphs of the statistics of the camp participants
+** Random group allocation of participants
+** Exporting participant information (by whole list, by Freshmen list or by OGL list) from the application to a readable format (Excel)
+** Importing participant information from Excel file to FOP Manager
 
 == 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_.
+* FOP Manager is built upon the awesome https://github.com/se-edu/[AddressBook-Level4] codebase by the SE-EDU initiative.
+* Some parts of this 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]
 
 == Licence : link:LICENSE[MIT]

build.gradle

@@ -61,6 +61,7 @@ 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: 'com.google.guava', name: 'guava', version: '19.0'
+    implementation group: 'org.apache.poi', name: 'poi', version: '4.0.1'
 
     testImplementation group: 'junit', name: 'junit', version: '4.12'
     testImplementation group: 'org.testfx', name: 'testfx-core', version: testFxVersion, {
@@ -77,7 +78,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = '[T08-4][FOPManager].jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -202,8 +203,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level4',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
+        'site-name': 'FOP Manager',
+        'site-githuburl': 'https://github.com/cs2113-ay1819s2-t08-4/main',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

docs/AboutUs.adoc

@@ -4,53 +4,44 @@
 :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.}_ +
-{empty} +
+FOP Manager was developed by the https://cs2113-ay1819s2-t08-4.github.io/main/AboutUs.html[T08-4] team, based on the Address Book Level 4 codebase.
+
 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>>]
+=== Chan Wei Zhang
+image::weizhang05.png[width="150", align="left"]
+{empty}[http://github.com/weizhang05[github]] [<<weizhang05#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Team Lead + Developer +
+Responsibilities: Integration
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Phan Duy Nhat Tan
+image::tantantan277.png[width="150", align="left"]
+{empty}[http://github.com/tantantan277[github]] [<<tantantan277#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: UI
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Shanon Seet Shwen Ling
+image::shanseet.png[width="150", align="left"]
+{empty}[http://github.com/shanseet[github]] [<<shanseet#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Logic + Documentation +
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Sonia Sunil
+image::ssunil3232.png[width="150", align="left"]
+{empty}[http://github.com/ssunil3232[github]] [<<ssunil3232#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Add, List, Export, Import features and Documentations
 
 '''

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.
-* *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/cs2113-ay1819s2-t08-4/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 any of the team members at soniasunil@u.nus.edu, [email protected], [email protected] or [email protected].