[CS2103-F09-4] LogOnce

LICENSE

@@ -2,11 +2,11 @@ MIT License
 
 Copyright (c) 2016 Software Engineering Education - FOSS Resources
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any client obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
+copies of the Software, and to permit clients to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all

README.md

@@ -1,14 +1,21 @@
-[![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.
+# LogOnce
+
+[![CI Status](https://github.com/AY2021S1-CS2103-F09-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-F09-4/tp/actions)
+
+![Ui](./docs/images/Ui.png)
+
+## About
+
+**LogOnce** is a one-stop logistics tracker app for clerks to monitor shipping statuses of all clients and perform common logistics operations. It is optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, LogOnce can get your tracking tasks done faster than traditional GUI apps.
+
+## Site Map
+
+* [About Us](https://ay2021s1-cs2103-f09-4.github.io/tp/AboutUs.html)
+* [User Guide](https://ay2021s1-cs2103-f09-4.github.io/tp/UserGuide.html)
+* [Developer Guide](https://ay2021s1-cs2103-f09-4.github.io/tp/DeveloperGuide.html)
+
+
+## Acknowledgements
+
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org)
+* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)

build.gradle

@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '8.29'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -42,7 +46,7 @@ task coverage(type: JacocoReport) {
 
 dependencies {
     String jUnitVersion = '5.4.0'
-    String javaFxVersion = '11'
+    String javaFxVersion = '11.0.1'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'

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
+### Xiao Chengxin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/cx0810.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/cx0810)]
+[[portfolio](team/cx0810.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: List and Undo commands
 
-### Jane Doe
+### Syasya Azman
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/syasyazman.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/Syasyazman)]
+[[portfolio](team/syasyazman.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Deletion commands
 
-### Johnny Doe
+### Ting Xiao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tigerting98.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/tigerting98)] [[portfolio](team/tigerting98.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Search commands
 
-### Jean Doe
+### Pua Xuan Ming
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/xnmng.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/xnmng)]
+[[portfolio](team/xnmng.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Update commands and Order classes
 
-### James Doe
+### You Yingfeng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/youyingfeng.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/youyingfeng)]
+[[portfolio](team/youyingfeng.md)]
 
 * Role: Developer
 * Responsibilities: UI