[CS2103-T12-4] NUS Classes

README.md

@@ -1,14 +1,32 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2122S2-CS2103T-T12-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S2-CS2103T-T12-4/tp/actions)
 
 ![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.
+# NUS Classes
+**NUS Classes** is an app that enables the professors to better manage contacts from large numbers of students and staff,
+and allows the professors to document the tasks that they need to do.
+
+### Features
+
+Features added on top of AB3.
+
+| Feature        | Description                                                                                                                      |
+|----------------|----------------------------------------------------------------------------------------------------------------------------------|
+| Create Task    | Add and schedule (*recurring*) tasks on NUS Classes easily with a single command.                                                |
+| Update Task    | Edit tasks which are outdated or when mistakes were made.                                                                        |
+| Delete Task    | Delete tasks which are unnecessary or when you are done with it.                                                                 |
+| Un/Assign Task | Assign and unassign contacts to a task. Help with organization and planning!                                                     |
+| View Task      | View the people assigned to a task. Help with remembering who you are suppose to meet!                                           |
+| Tag Task       | Tag a task with different tags. Help with categorizing tasks!                                                                    |
+| Filter Task    | Too many tasks? Filter them based on keywords!                                                                                   |
+| Alert          | Forgetful? No worries, tasks in NUS Classes are color coded to allow you to quickly identify tasks that are overdue or due soon! |
+
+### Others
+
+* **User Guide** for NUS Classes can be found here: [User Guide](https://ay2122s2-cs2103t-t12-4.github.io/tp/UserGuide.html).
+* **Developer Guide** for NUS Classes can be found here: [Developer Guide](https://ay2122s2-cs2103t-t12-4.github.io/tp/DeveloperGuide.html).
+
+### Acknowledgements
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+Additionally, this project was adopted from the existing AB3 se-education.org project. Please refer
+to the AB3 product website **[here](https://se-education.org/addressbook-level3/)** for more information.

build.gradle

@@ -16,10 +16,18 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true
+}
+
 checkstyle {
     toolVersion = '8.29'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +74,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'NUSClasses.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,51 @@ 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 through our Github usernames.
 
 ## Project team
 
-### John Doe
+### Brian
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/brian16600.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/brian16600)]] [[portfolio](team/brian16600.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilites: Code Quality + Documentation
 
-### Jane Doe
+### Sean Ng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/snss231.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/snss231)]] [[portfolio](team/snss231.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Data
 
-### Johnny Doe
+### Ong Jun Jie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/junjunjieong.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/junjunjieong)]] [[portfolio](team/junjunjieong.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Code quality + Deliverables and deadlines
 
-### Jean Doe
+### Tan Jun Rong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/junrong98.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/junrong98)]] [[portfolio](team/junrong98.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Code Quality, In Charge of Tagging
 
-### James Doe
+### Adrian Ong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/adrianongjj.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/AdrianOngJJ)]] [[portfolio](team/adrianongjj.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Glossary + Documentation