= Resident Book ifdef::env-github,env-browser[:relfileprefix: docs/] ifdef::env-github,env-browser[:outfilesuffix: .adoc]

https://travis-ci.org/CS2103AUG2017-F09-B1/main[image:https://travis-ci.org/CS2103AUG2017-F09-B1/main.svg?branch=master[Build Status]] https://ci.appveyor.com/project/CS2103AUG2017-F09-B1/main[image:https://ci.appveyor.com/api/projects/status/0n4qfceq2tujddy7/branch/master?svg=true[Build status]] https://coveralls.io/github/CS2103AUG2017-F09-B1/main?branch=master[image:https://coveralls.io/repos/github/CS2103AUG2017-F09-B1/main/badge.svg?branch=master[Coverage Status]] https://www.codacy.com/app/Haozhe321/main?utm_source=github.com&utm_medium=referral&utm_content=CS2103AUG2017-F09-B1/main&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/626b9cc0538e40dba82ab88838923926[Codacy Badge]]

ifdef::env-github[] image::docs/images/Ui.png[width="900"] endif::[]

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

• This is a desktop Resident Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
• Resident Book is a newly conceptualised administrative tool catered for staffs handling hostel and college operations.
• Administrative staff often face difficulties in collating and gathering information from off-the-shelf software such as Excel, and may miss out important details using a large spreadsheet.
• Some common features include Events handling mechanism Tags to keep track of exchange/guests stays Temporary contacts for exchange/guests stays Import and backup of data for easier maintenance Typing and GUI available for efficient and effective operations Auto-complete to increase efficiency ** Calendar so you never lose track of the days

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

• This project is built upon the AddressBook-Level4 project created by https://github.com/se-edu/[SE-EDU initiative].

• The calendar used is inspired by the JavaFX calendar by https://github.com/SirGoose3432/javafx-calendar[SirGoose3432].

== Licence : link:LICENSE[MIT]