[CS2103-T14-3] MyCRM

README.md

@@ -1,14 +1,24 @@
-[![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-CS2103-T14-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S1-CS2103-T14-3/tp/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.
+## MyCRM
+MyCRM, short for _"My Customer Relationship Manager"_, is a desktop application for managing client contacts, repair job 
+statuses, and product information. <br>
+
+* It is targeted at computer repair shop technician. Specifically, it can help he/she to
+  * Centralize on-going jobs and client information in a single application.
+  * Integrate a job status tracking system.
+  * Integrate a client notification system.
+  * Generate monthly reports and statistics automatically.<br>
+* It has been optimised for use via a Command Line Interface (CLI) while maintaining the benefits of a Graphical User 
+  Interface (GUI).
+
+### About our project
+* It is an ongoing software project with regular updates and constantly improving features.
+* It is written in OOP fashion and provides a reasonably well-written code base with around 6k LoC. 
+* It comes with a reasonable level of user and developer documentation.
+* For the detailed documentation of this project, see the **[MyCRM Product Website](https://ay2122s1-cs2103-t14-3.github.io/tp/)**.
+
+### Acknowledgment
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.mycrm.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +66,16 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'MyCrm.jar'
+}
+
+run {
+    enableAssertions = true;
+}
+
+tasks.withType(JavaCompile) {
+    options.fork = true
+    options.forkOptions.jvmArgs += ["-Duser.language=en"]
 }
 
 defaultTasks 'clean', 'test'

copyright.txt

@@ -1,8 +1,8 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
-Copyright by Susumu Yoshida - http://www.mcdodesign.com/
-- address_book_32.png
-- AddressApp.ico
+Copyright Free Icons Library - hhttps://icon-library.com/icon/crm-icon-3.html
+- myCrm_icon.png
+- MyCrmApp.ico
 
 Copyright by Jan Jan Kovařík - http://glyphicons.com/
 - calendar.png

docs/AboutUs.md

@@ -7,53 +7,70 @@ We are a team based in the [School of Computing, National University of Singapor
 
 You can reach us at the email `seer[at]comp.nus.edu.sg`
 
-## Project team
+## Project Team
 
-### John Doe
+### Timothy Chua
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ooawagaeri.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/ooawagaeri)]
+[[portfolio](team/ooawagaeri.md)]
 
-* Role: Project Advisor
+* Role: Team Lead, Scheduling and Tracking
+* Responsibilities:
+  * Focus on issues.
+  * Defining, assigning, and tracking project tasks.
+  * Ensuring everyone has manageable task.
 
-### Jane Doe
+### Hang Zelin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images\hangzelin.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/hangzelin)]
+[[portfolio](team/hangzelin.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Code Quality / Integration handler
+* Responsibilities:
+  * Pull request reviewer.
+  * Merging of pull requests.
+  * Ensure adherence to coding standards.
 
-### Johnny Doe
+<br><br>
+### Zhang Yubin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images\kimowarui.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/Kimowarui)]
+[[portfolio](team/kimowarui.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Deliverables and Deadlines
+* Responsibilities:
+  * Focus on milestones page.
+  * Update milestones according to CS2103 website.
+  * Ensure project deliverables are done on time and in the right format.
+  * Chase people if need be.
 
-### Jean Doe
+### Fan Tianhao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images\ttraveller7.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/TTraveller7)]
+[[portfolio](team/ttraveller7.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Documents
+* Responsibilities:
+  * Ensure quality of various project documents
+  * UI mockup and design
 
-### James Doe
+### Dhruv Shah
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/dhshah1.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/dhshah1)]
+[[portfolio](team/dhshah1.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Tester
+* Responsibilities:
+  * Ensure proper tests are written for all modules
+  * Ensure new features/modules don't introduce bugs
+  * Ensure application works as expected