[W16-2] SocialCare

.gitignore

@@ -8,7 +8,7 @@ lib/*
 *.log
 *.log.*
 *.csv
-config.json
+/config.json
 src/test/data/sandbox/
 preferences.json
 .DS_Store
@@ -18,3 +18,4 @@ classes/
 /bin/
 src/main/resources/docs/
 out/
+Certs/

LICENSE

@@ -2,7 +2,7 @@ MIT License
 
 Copyright (c) 2016 Software Engineering Education - FOSS Resources
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any volunteer obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

README.adoc

@@ -1,11 +1,9 @@
-= Address Book (Level 4)
+= SocialCare
 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://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+https://travis-ci.org/CS2103-AY1819S1-W16-2/main[image:https://travis-ci.org/CS2103-AY1819S1-W16-2/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/Kratious/main[image:https://ci.appveyor.com/api/projects/status/suon744fyw9kqi3x?svg=true[Build status]]
+https://coveralls.io/github/CS2103-AY1819S1-W16-2/main?branch=master[image:https://coveralls.io/repos/github/CS2103-AY1819S1-W16-2/main/badge.svg?branch=master[Coverage Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,24 +13,27 @@ 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.
+* SocialCare is a social welfare event and volunteer management system. It is a desktop application and  has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
+* It is *written in OOP fashion*, and is morphed from the https://se-edu.github.io/docs/Team.html[se-edu] team's https://github.com/nus-cs2103-AY1819S1/addressbook-level4[Address Book - Level 4], which provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC) than what students usually write in beginner-level SE modules.
+* This application is intended for social welfare organisations that want to better manage their volunteers & events, and export volunteer certificates.
+* SocialCare allows users to:
+** Manage contacts and events faster than a typical mouse/GUI driven app.
+** Use tags to categorize events and volunteers.
+** Manage additional volunteer data, such as number of service hours per volunteer.
+** Export volunteer certificates detailing each volunteer's involvement in the organisation's events.
+
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
+* This application is based on https://github.com/nus-cs2103-AY1819S1/addressbook-level4[Address Book - Level 4] developed by
+the https://se-edu.github.io/docs/Team.html[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://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]

_reposense/config.json

@@ -0,0 +1,30 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "afiqlattif",
+      "displayName": "MUHAM...ATTIF",
+      "authorNames": ["afiqlattif", "Afiq Lattif"]
+    },
+    {
+      "githubId": "Scrubbius",
+      "displayName": "NGOH ...N JUN",
+      "authorNames": ["Scrubbius"]
+    },
+    {
+      "githubId": "Kratious",
+      "displayName": "SEM J...G HAN",
+      "authorNames": ["Kratious"]
+    },
+    {
+      "githubId": "sharan8",
+      "displayName": "THANG...HARAN",
+      "authorNames": ["sharan8", "Sharan"]
+    },
+    {
+      "githubId": "iMarbles",
+      "displayName": "YEO Y...MABEL",
+      "authorNames": ["iMarbles"]
+    }
+  ]
+}

build.gradle

@@ -79,6 +79,8 @@ dependencies {
     testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: 'jdk-9+181'
     testRuntimeOnly group:'org.junit.vintage', name:'junit-vintage-engine', version: jUnitVersion
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    compile 'org.apache.pdfbox:pdfbox:2.0.2'
 }
 
 shadowJar {
@@ -207,9 +209,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-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
+        'site-name': 'SocialCare',
+        'site-githuburl': 'https://github.com/CS2103-AY1819S1-W16-2/main'
     ]
 
     options['template_dirs'].each {

docs/AboutUs.adoc

@@ -4,53 +4,49 @@
 :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} +
-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>>]
+=== Afiq Lattif
+image::afiqlattif.png[width="150", align="left"]
+{empty}[https://github.com/afiqlattif[github]] [<<afiqlattif#, portfolio>>]
 
-Role: Project Advisor
+Role: Developer +
+Responsibilities: Volunteer Management Feature
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Sem Jing Han
+image::kratious.png[width="150", align="left"]
+{empty}[http://github.com/kratious[github]] [<<kratious#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Developer +
+Responsibilities: Event Management Feature
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Amabel Yeo
+image::imarbles.png[width="150", align="left"]
+{empty}[https://github.com/iMarbles[github]] [<<imarbles#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: Assignment of Volunteers Feature
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Thangavel Sharan
+image::sharan8.png[width="150", align="left"]
+{empty}[https://github.com/sharan8[github]] [<<sharan8#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Certificate Export Feature
 
 '''
 
-=== Benson Meier
+=== Ngoh Wen Jun
 image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+{empty}[https://github.com/Scrubbius[github]] [<<scrubbius#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Data Management Feature
 
 '''