[CS2103-F10-4] TuitionConnect

README.md

@@ -1,14 +1,10 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# TuitionConnect
+
+[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-F10-4/tp/actions)
 
 ![Ui](docs/images/Ui.png)
+### Description
+TuitionConnect is a powerful **CLI** application designed to streamline the management of your tutoring business for **private tutors**. TuitionConnect helps to effortlessly *manage students*, *schedules* and *progress tracking* while ensuring *financial organization*.
 
-* 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.
+### Credits
+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

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

config/checkstyle/checkstyle.xml

@@ -16,7 +16,7 @@
 
   <module name="NewlineAtEndOfFile">
     <!-- Accept LF, CR or CRLF to accomodate devs who prefer different line endings -->
-    <property name="lineSeparator" value="lf_cr_crlf"/>
+    <property name="lineSeparator" value="lf_cr_crlf" />
   </module>
 
   <module name="RegexpSingleline">

docs/AboutUs.md

@@ -9,51 +9,49 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Lang Heran
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/heran9.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/heran9)] [[portfolio](team/heran9.md)]
 
-* Role: Project Advisor
-
-### Jane Doe
+* Role: Developer
+* Responsibilities: Feature development, Documentation, Testing
 
-<img src="images/johndoe.png" width="200px">
+### Lim Yih Fei
+<img src="images/yihfei.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/yihfei)]
+[[portfolio](team/yihfei.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Quality Assurance, UI
 
-### Johnny Doe
+### Lam Jin Heng Braydon
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lambraydon.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/lambraydon)] [[portfolio](team/lambraydon.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Feature Development, Quality Assurance, UI
 
-### Jean Doe
+### Armando Jovan Kusuma
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jovkusuma.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jovkusuma)]
+[[portfolio](team/jovkusuma.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Feature Development, Quality Assurance, Testing
 
-### James Doe
+### Winston Leonard Prayonggo
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/winstonleonard.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/WinstonLeonard)]
+[[portfolio](team/winstonleonard.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Refactoring code, Feature Development, Testing