nus-cs2103-AY2021S1 · mkeoliya · Oct 28, 2020 · Oct 28, 2020 · Oct 28, 2020 · Oct 28, 2020
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,2 @@
 *.pdf binary
+*.class binary
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,14 @@
+### What this does
+This PR <!-- your WCT essay here -->
+
+<!-- Delete accordingly -->
+Fixes|Closes|Part of #1337.
+
+### How to test
+<!-- Write an essay here if it's more suitable -->
+1. Launch the application.
+2. 
+
+### Notes
+<!-- Anything else we should take note of, e.g. how this affects future PRs,
+issues faced, etc. -->
diff --git a/.gitignore b/.gitignore
@@ -1,12 +1,19 @@
+*.class
+
 # Gradle build files
 /.gradle/
 /build/
 src/main/resources/docs/
+bin/
 
 # IDEA files
 /.idea/
 /out/
 /*.iml
+.settings/
+.project
+.classpath
+docs/.gradle/
 
 # Storage/log files
 /data/

diff --git a/README.md b/README.md
@@ -1,14 +1,31 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![Java CI](https://github.com/AY2021S1-CS2103-T16-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-T16-3/tp/actions)
+[![codecov](https://codecov.io/gh/AY2021S1-CS2103-T16-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103-T16-3/tp)
+
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+**ResiReg** (**Res**idential **Reg**ulation) is a desktop app designed to help admin staff at Residential Colleges (RCs)* in NUS with their daily tasks. ResiReg allows admin to manage room and student records, including the allocation students to rooms.
+
+**ResiReg** has the following main features:
+
+* Manage records of students.
+* Manage records of rooms.
+* Manage allocations of students to rooms in the College
+* Useful productivity features such as command history, command aliasing and in-app help.
+
+Our application is geared towards users who prefer typing over mouse actions, so interactions with our application are mainly keyboard based.
+
+## Site Map
+
+ * [User Guide](docs/UserGuide.md)
+ * [Developer Guide](docs/DeveloperGuide.md)
+ * [About Us](docs/AboutUs.md)
+ * [Contact Us](docs/ContactUs.md)
+
+## Acknowledgements
+
+ * This project is a based off the AddressBook-Level3 project, created by SE-EDU initiative at https://se-education.org
+ * 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: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+
+## License : [MIT](LICENSE)
diff --git a/build.gradle b/build.gradle
@@ -4,9 +4,10 @@ plugins {
     id 'com.github.johnrengelman.shadow' version '4.0.4'
     id 'application'
     id 'jacoco'
+    id "com.star-zero.gradle.githook" version "1.2.1"
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.resireg.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +67,21 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'resireg.jar'
+}
+
+githook {
+    failOnMissingHooksDir = true
+    createHooksDirIfNotExist = true
+    hooks {
+        "pre-push" {
+            task = "test clean checkstyleMain checkStyleTest"
+        }
+    }
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -5,55 +5,56 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can reach us at the email `e0407889[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Mayank Keoliya
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/mkeoliya.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/mkeoliya)]
+[[portfolio](team/mkeoliya.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Scheduling & Tracking, Maintaining Code Quality
 
-### Jane Doe
+### Loh Jing Yen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jingyenloh.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jingyenloh)]
+[[portfolio](team/jingyenloh.md)]
 
 * Role: Team Lead
 * Responsibilities: UI
 
-### Johnny Doe
+### Bec Kyung Huhn (Kevin)
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lysire.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/lysire)]
+[[portfolio](team/lysire.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Developer, IntelliJ Expert
+* Responsibilities: Deliverables and Deadlines
 
-### Jean Doe
+### New Jun Jie (Jet)
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jetnew.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jetnew)]
+[[portfolio](team/jetnew.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Developer, Intellij Expert
+* Responsibilities: Documentation, Allocation Feature, Piechart Feature
 
-### James Doe
+### Chloe Lee Ke Er
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/chloelee767.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/chloelee767)]
+[[portfolio](team/chloelee767.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Developer, Git Expert
+* Responsibilities: Testing
diff --git a/docs/ContactUs.md b/docs/ContactUs.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: Contact Us
+---
+
+* *Bug reports, Suggestions* : Post in our [issue tracker](https://github.com/AY2021S1-CS2103-T16-3/tp) if you noticed bugs or have suggestions on how to improve.
+* *Contributing* : We welcome pull requests. Follow the process described [here](https://github.com/oss-generic/process)
+* *Email us* : You can also reach us at `[email protected]`, `[email protected]`, `[email protected]`, `[email protected]` or `[email protected]`.