= SocialCare ifdef::env-github,env-browser[:relfileprefix: docs/]

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"] endif::[]

ifndef::env-github[] image::images/Ui.png[width="600"] endif::[]

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

== Licence : link:LICENSE[MIT]