[CS2103-F11-4] NUScheduler

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-CS2103-F11-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S2-CS2103-F11-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2122S2-CS2103-F11-4/tp/branch/master/graph/badge.svg?token=G5ITTT4UTJ)](https://codecov.io/gh/AY2122S2-CS2103-F11-4/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.
+# NUScheduler
+***
+NUScheduler is a desktop app for Year 1 Computing students to assist with more efficient management of tasks and contacts,
+optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).
+If you can type fast, NUScheduler can schedule your tasks faster than traditional GUI apps.<br>
+
+## Uses:
+***
+  * keep track of all school contacts, modules and tasks
+  * organise academic life in a neat manner
+
+## Features:
+***
+  * Add a task/contact
+  * Delete a task/contact
+  * Update a task/contact
+  * Find task(s)
+  * View all tasks and their deadlines
+  * View all contacts
+  * Remind upcoming tasks (coming soon)
+
+## Acknowledgements
+***
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative.](https://se-education.org)
+* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+

build.gradle

@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '8.29'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'NUScheduler.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,41 @@ 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 `e0544443@u.nus.edu`
 
 ## Project team
 
-### John Doe
+### Chen Yu An
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/putaojuice.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Project Advisor
-
-### Jane Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/putaojuice)]
+[[portfolio](team/putaojuice.md)]
 
 * Role: Team Lead
-* Responsibilities: UI
-
-### Johnny Doe
 
-<img src="images/johndoe.png" width="200px">
+### Low Weimin, Ian
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/castryl.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Data
+[[github](http://github.com/castryl)]
+[[portfolio](team/castryl.md)]
 
-### Jean Doe
+* Role: Documentation
 
-<img src="images/johndoe.png" width="200px">
+### Ivor Chua
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/ivorcmx.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+[[github](http://github.com/ivorcmx)]
+[[portfolio](team/ivorcmx.md)]
+* Role: Testing
 
-### James Doe
+### Tan Yu Meng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/yumengtan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/yumengtan)]
+[[portfolio](team/yumengtan.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Code Quality