[CS2103T-W15-2] Trackr

.gitignore

@@ -20,3 +20,6 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+*.class
+bin/

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)
 
 ![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.
+# Trackr
+
+[![CI Status](https://github.com/AY2223S2-CS2103T-W14-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S2-CS2103T-W14-2/tp/actions)
+[![codecov](https://codecov.io/gh/AY2223S2-CS2103T-W15-2/tp/branch/master/graph/badge.svg?token=DBXVG742QT)](https://codecov.io/gh/AY2223S2-CS2103T-W15-2/tp)
+
+This repository contains the code base for a Java application for small online bakery businesses.
+
+## About The Project
+
+* The project is a desktop application (called _Trackr_) that targets users with a Command Line Interface (CLI), while providing the visuals using a Graphical User Interface (GUI).
+  * It is a software engineering project for a module (**CS2103T Software Engineering**) by National University of Singapore (NUS).
+  * It is **written in OOP fashion**.
   * 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.
+* It is named `Trackr` because it was created to help users **track** their orders, suppliers contact information and tasks.
+* For the detailed documentation of this project, see the **[Trackr Product Website](https://ay2223s2-cs2103t-w15-2.github.io/tp/)**.
+
+## Acknowledgements
+
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* If you would like to contribute code to the parent project (AddressBook-Level3), see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.

build.gradle

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

docs/AboutUs.md

@@ -9,51 +9,52 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Liu Muchen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/liumc-sg.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/LiuMC-SG)]
+[[portfolio](team/liumc-sg.md)]
 
-* Role: Project Advisor
+* Role: Software Developer
+* Responsibilities: Team Lead (Documentation, Deliverables)
 
-### Jane Doe
+### Darren Chang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/changgittyhub.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ChangGittyHub)]
+[[portfolio](team/changgittyhub.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Software Developer
+* Responsibilities: Scheduling & Tracking
 
-### Johnny Doe
+### Arkar Kyaw Aung
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/arkarsg.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/arkarsg)]
+[[portfolio](team/arkarsg.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI & Testing
 
-### Jean Doe
+### Hmuu Myat Moe
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hmuumyatmoe.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/HmuuMyatMoe)]
+[[portfolio](team/hmuumyatmoe.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Documentation & Code Quality
 
-### James Doe
+### Chong Wei Guan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/chongweiguan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/chongweiguan)]
+[[portfolio](team/chongweiguan.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Deliverables & Deadlines

docs/DevOps.md

@@ -73,7 +73,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/AY2223S2-CS2103T-W15-2/tp/blob/master/src/main/java/trackr/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.