[CS2103T-T11-1] NUSMates

.gitignore

@@ -1,8 +1,12 @@
 # Gradle build files
 /.gradle/
 /build/
+/bin/
 src/main/resources/docs/
 
+# VSCode files
+/.vscode/
+
 # IDEA files
 /.idea/
 /out/

README.md

@@ -1,14 +1,23 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# NUSMates
+
+[![CI Status](https://github.com/AY2425S2-CS2103T-T11-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S2-CS2103T-T11-1/tp/actions)
+
+[![codecov](https://codecov.io/gh/AY2425S2-CS2103T-T11-1/tp/graph/badge.svg?token=VA2F7WUH2X)](https://codecov.io/gh/AY2425S2-CS2103T-T11-1/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.
+**NUSMates allows NUS undergraduate students to record the contact details of their fellow NUS undergraduate students.** With NUSMates, you can record NUS-specific contact information such as [year](#year), [major](#major), housing, and [modules](#module).
+NUSMates also makes it seamless to record [module](#module) information using an [NUSMods link](#nusmods-link), helping you easily find friends who are taking the same [modules](#module) - so you can form project groups, share notes, or know who to reach out to for help.
+
+This is our team project for CS2103T; it is based on the AddressBook-Level3 (AB3) project created by the [SE-EDU initiative](https://se-education.org). In addition to the functionalities provided in AB3, we introduce features that can help NUS students better manage their contacts' information.
+
+## Project 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/#contributing-to-se-edu) for more info.
+
+## Selected features
+* **NUS-Specific Information:** users can add NUS-specific contact information such as year, major, housing, and modules
+* **Integration with [NUSMods](https://nusmods.com):** this allows users to seamlessly add a contact's timetable to their info using a NUSMods link.
+* **Module Search:** we allow users to find coursemates for any of their courses making it easier to find teammates in advance.
+
+For the detailed documentation of this project, see the **[NUSMates Product Website](https://se-education.org/addressbook-level3)**.

build.gradle

@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'nusmates.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/.gitignore

@@ -0,0 +1,10 @@
+# .gitignore for Jekyll.
+# source: https://github.com/github/gitignore/blob/main/Jekyll.gitignore
+
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+# Ignore folders generated by Bundler
+.bundle/
+vendor/

docs/AboutUs.md

@@ -1,59 +1,50 @@
 ---
 layout: page
+nav_order: 4
 title: About Us
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
+# About Us
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+We are CS2103T-T11 Team 1, a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
 
 ## Project team
 
-### John Doe
+### Abi Halim
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/abihalim.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/AbiHalim)]
 
-* Role: Project Advisor
-
-### Jane Doe
-
-<img src="images/johndoe.png" width="200px">
+* Role: Team Lead
+* In charge of Documentation
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Vee Hua Zhi
 
-* Role: Team Lead
-* Responsibilities: UI
+<img src="images/veehz.png" width="200px">
 
-### Johnny Doe
+* Role: Code Quality
+* In charge of ensuring Code Quality
 
-<img src="images/johndoe.png" width="200px">
+### Shashwat Chandra
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/shashwatchan.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Data
+[[github](http://github.com/shashwatchan)]
+[[website](http://shashwatchandra.com)]
 
-### Jean Doe
+* Role: PM
+* Responsibilities: Testing
 
-<img src="images/johndoe.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Song Yuexi
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+<img src="images/yosiesyx.png" width="200px">
 
-### James Doe
+[[github](https://github.com/YosieSYX)]
+[[portfolio](https://yosiesyx.github.io/SongYuexi/)]
 
-<img src="images/johndoe.png" width="200px">
+* Role: Testing, Scheduling and tracking
+* Responsibilities: In charge of defining, assigning, and tracking project tasks, Ensures the testing of the project is done properly and on time.
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
-* Role: Developer
-* Responsibilities: UI

docs/Configuration.md

@@ -1,5 +1,6 @@
 ---
 layout: page
+nav_exclude: true
 title: Configuration guide
 ---
 

docs/DevOps.md

@@ -1,5 +1,6 @@
 ---
 layout: page
+nav_exclude: true
 title: DevOps guide
 ---
 
@@ -73,7 +74,7 @@ Any warnings or errors will be printed out to the console.
 
 Here are the steps to create a new release.
 
-1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
+1. Update the version number in [`MainApp.java`](https://github.com/{{site.repository}}/tree/master/src/main/java/seedu/address/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
 1. Tag the repo with the version number. e.g. `v0.1`
 1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.