[CS2103T-W12-2] SWEe-book

README.md

@@ -1,14 +1,33 @@
-[![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/AY2122S1-CS2103T-W12-2/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2122S1-CS2103T-W12-2/tp/actions/workflows/gradle.yml)
+[![codecov](https://codecov.io/gh/AY2122S1-CS2103T-W12-2/tp/branch/master/graph/badge.svg?token=MORDANUUIH)](https://codecov.io/gh/AY2122S1-CS2103T-W12-2/tp)
 
+# SWEe-book
+**SWEe-book** is a desktop app that makes it easier for CS2103T/CS2101 students to
+**keep track of their tasks and group mates in different groups**.
+
+### Features
+1. Adding a contact
+1. Editing a contact
+1. Deleting a contact
+1. Filtering contacts by name
+1. Filtering contacts by group
+1. Listing all contacts
+1. Adding a task
+1. Editing a task
+1. Deleting a task
+1. Marking a task as done
+1. Sorting tasks
+1. Filtering tasks by modules
+1. Listing all tasks
+
+### SWEe-book GUI
 ![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.
+### User Guide
+The User Guide can be accessed [here](https://github.com/AY2122S1-CS2103T-W12-2/tp/blob/master/docs/UserGuide.md).
+
+### Developer Guide
+The Developer Guide can be accessed [here](https://github.com/AY2122S1-CS2103T-W12-2/tp/blob/master/docs/DeveloperGuide.md).
+
+#### Acknowledgements
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,11 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+run {
+    enableAssertions = true
+}
+
+mainClassName = 'sweebook.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'sweebook.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -9,51 +9,47 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Alina Lee
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/alinaleehx.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/alinaleehx)] [[portfolio](team/alinaleehx.md)]
 
-* Role: Project Advisor
+* Role: Documentation
+* Responsibilities: Responsible for the quality of various project documents.
 
-### Jane Doe
+### Joseph Nathanael
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/josephn37.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/JosephN37)] [[portfolio](team/JosephN37.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Deliverables and deadlines
+* Responsibilities: Ensure project deliverables are done on time and in the right format.
 
-### Johnny Doe
+### Yeu Chen Yuan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/cyyeu.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/cyyeu)] [[portfolio](team/cyyeu.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Code quality
+* Responsibilities: Ensure overall adherence to coding standards.
 
-### Jean Doe
+### Ambrose Boo
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ambroseboo.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/ambroseboo)] [[portfolio](team/ambroseboo.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Scheduling and Tracking
+* Responsibilities: In charge of defining, assigning and tracking project tasks.
 
-### James Doe
+### Tan Zhen Xuan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zhenxuantan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/zhenxuantan)] [[portfolio](team/zhenxuantan.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: UI/UX
+* Responsibilities: Responsible for the UI/UX component of the SWEe-book app.