[CS2103T-W12-4] ModuLink

README.md

@@ -1,14 +1,26 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/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.
+[![CI Status](https://github.com/AY2122S1-CS2103T-W12-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S1-CS2103T-W12-4/tp/actions)
+
+# ModuLink
+
+### The **best** module partner finder for CS students.
+
+#### Overview
+- [X] Text based CLI commands - for the fast coders
+- [X] Simple - learn in seconds
+- [X] Fastest - 0 ping
+
+> Better than Tinder! - SoC CS students
+
+#### Features
+1. Create and edit your own profile
+2. Add and remove as favourite
+3. Find by name
+4. Filter by module
+5. Filter by grouping status
+6. And many more!
+
+For a more detailed documentation of this project, please visit our [Product Website](https://ay2122s1-cs2103t-w12-4.github.io/tp/UserGuide)!
+
+#### Ui Mockup for ModuLink
+
+![Ui Mockup](docs/images/screenshots/Ui.png)

build.gradle

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

docs/AboutUs.md

@@ -5,55 +5,53 @@ 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`
-
 ## Project team
 
-### John Doe
-
-<img src="images/johndoe.png" width="200px">
+### Aakansha Narain
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/developerPhotos/aakanshanarain.png" width="200px">
 
-* Role: Project Advisor
+[[github](https://github.com/aakanshanarain)]
+[[portfolio](team/aakanshanarain.md)]
 
-### Jane Doe
+* Role: Developer
+* Responsibilities: Delivarables
+### Charlton Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/developerPhotos/charltonator.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/charltonator)]
+[[portfolio](team/charltonator.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Testing
 
-### Johnny Doe
+### Ethan Wong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/developerPhotos/ethanwong6362.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/ethanwong6362)]
+[[portfolio](team/ethanwong6362.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Logic flow
 
-### Jean Doe
+### Ng Jia Yuan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/developerPhotos/ngjiayuan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ngjiayuan)]
+[[portfolio](team/ngjiayuan.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Team Lead
+* Responsibilities: Code quality and team operations
 
-### James Doe
+### Zachary Lau
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/developerPhotos/zacharylwy.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/zacharylwy)]
+[[portfolio](team/zacharylwy.md)]
 
 * Role: Developer
 * Responsibilities: UI