[CS2103-T17-4] NUSCourseMates

README.md

@@ -1,14 +1,17 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+
+# NUSCoursemates
+
+[![CI Status](https://github.com/AY2324S1-CS2103T-T17-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T17-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-T17-4/tp/graph/badge.svg?token=9JMFF1YYFO)](https://codecov.io/gh/AY2324S1-CS2103T-T17-4/tp)
+
+**NUSCoursemates** is a desktop app for managing contacts and their courses, 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, NUSCourseMates can get your contact management tasks done faster than traditional GUI apps.
 
 ![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.
+## Features
+* Add, edit or delete students along with their courses
+* Sort students by name or courses
+* Find students by name or courses
+
+For the detailed documentation of this project, see the **[NUSCoursemates Product Website](https://ay2324s1-cs2103t-t17-4.github.io/tp/)**. 
+</br>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.

build.gradle

@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -40,6 +44,7 @@ task coverage(type: JacocoReport) {
     }
 }
 
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '17.0.7'
@@ -66,7 +71,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'NUSCoursemates.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -9,51 +9,51 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Joel Foo
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/joel-foo.png" width="200px">
 
 [[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/joel-foo)]
+[[portfolio](team/joel-foo.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
 
-### Jane Doe
+### Tan Teck Fang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tanteckfang.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tanteckfang)]
+[[portfolio](team/tanteckfang.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Documentation
+* Responsibilities: Quality of various project documents
 
-### Johnny Doe
+### Leon Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/leontan2.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/leontan2)] [[portfolio](team/leontan2.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Code Quality
+* Responsibilities: Looks after code quality, ensures adherence to coding standards, etc.
 
-### Jean Doe
+### Chew Jing Heng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/chewjh1234.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/chewjh1234)]
+[[portfolio](team/chewjh1234.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Deliverables and deadlines
+* Responsibilities: Ensure project deliverables are done on time and in the right format
 
-### James Doe
+### Carlin Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/carlintyj.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/carlintyj)]
+[[portfolio](team/carlintyj.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Tool Expert
+* Responsibilities: Helps other team member with matters related to the relevant tools