[CS2103T-F11-3] ProductiveNUS

README.md

@@ -1,14 +1,56 @@
-[![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/AY2021S1-CS2103T-F11-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-F11-3/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.
+## Project scope
+* ProductiveNUS is a desktop application that provides an accessible platform for NUS computing students to manage and keep track of their academic tasks at hand.  
+
+ * 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**.
+
+## Motivation
+* As a NUS Computing Student, you would probably have had **difficulties managing your
+academic schedule**. You might often feel overwhelmed due to 
+**tight deadlines** for your assignments along with a **high workload** which you might be
+on the verge of being unable to 
+cope with. In events like this, having a **disorganised timeline** makes your
+situation worse. You might often **underestimate the time
+it takes** to complete your assignments and you might be **late for your lessons** as you were preoccupied 
+with completing them. However, all these
+tasks still remain uncompleted. You might have been spinning your wheels.
+* ProductiveNUS minimises such problems by helping you keep track of your schedule easily.
+
+## Aim
+* **Effective time management** among NUS Computing students, resulting in **higher productivity**.
+* **Efficiency** in browsing through all your academic tasks (lessons and assignments) at once.
+* **Better planning** of your academic schedule.
+
+## User stories
+| No. | As a...           | I can...                              | So that I can...                                                          |
+|-----|-------------------|---------------------------------------|---------------------------------------------------------------------------|
+| 1   | Student           | import my timetable from NUSMods      | better schedule my assignments with my lesson  timings taken into account |
+| 2   | Forgetful student | receive reminders for my assignments  | avoid forgetting to attend my lessons or do my work                       |
+| 3   | Poor time manager | add and schedule assignments          | keep track of what needs  to be done                                      |
+| 4   | Poor time manager | delete assignments                    | remove assignments that I have completed  or added wrongly                |
+| 5   | Poor time manager | view lessons and assignments together | view all the assignments I have to complete amidst  my lessons            |
+
+## Current features supported
+* Importing timetable from NUSMods
+* Adding assignments to ProductiveNUS
+* Listing lessons and assignments 
+* Deleting assignments from ProductiveNUS
+* Reminders for assignments
+* Exiting ProductiveNUS
+
+## Site Map
+* [Developer Guide](https://ay2021s1-cs2103t-f11-3.github.io/tp/DeveloperGuide.html)
+
+* [User Guide](https://ay2021s1-cs2103t-f11-3.github.io/tp/UserGuide.html)
+
+* [About Us](https://ay2021s1-cs2103t-f11-3.github.io/tp/AboutUs.html)
+
+## Acknowledgements
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+

build.gradle

@@ -16,6 +16,10 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true
+}
+
 checkstyle {
     toolVersion = '8.29'
 }
@@ -60,13 +64,15 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
+    implementation 'com.googlecode.json-simple:json-simple:1.1.1'
+
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'productivenus.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,57 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
+[Click](https://ay2021s1-cs2103t-f11-3.github.io/tp/) to view the homepage for ProductiveNUS.
+
 You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Andrea Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/andreatanky.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/andreatanky)]
+[[portfolio](team/andreatanky.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: UI
 
-### Jane Doe
+### Choo Jia Xin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/choojiaxin.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ChooJiaXin)]
+[[portfolio](team/choojiaxin.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer; Deliverables and deadlines
+* Responsibilities: Code quality
 
-### Johnny Doe
+### Jerry Ho
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/printinghelloworld.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/printinghelloworld)] [[portfolio](team/printinghelloworld.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Developer; Deliverables and deadlines
+* Responsibilities: Documentation
 
-### Jean Doe
+### Hwang Yong Kang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hyngkng.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/hyngkng)]
+[[portfolio](team/hyngkng.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Developer; Deliverables and deadlines
+* Responsibilities: Testing
 
-### James Doe
+### Nguyen Hoang Hai Minh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/minhhhnguyen2000.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/minhhhnguyen2000)]
+[[portfolio](team/minhhhnguyen2000.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Developer; Deliverables and deadlines
+* Responsibilities: Testing