[CS2103T-T11-3] NUStorage

.github/workflows/gradle.yml

@@ -43,3 +43,4 @@ jobs:
         with:
           file: ${{ github.workspace }}/build/reports/jacoco/coverage/coverage.xml
           fail_ci_if_error: true
+

.gitignore

@@ -7,6 +7,7 @@ src/main/resources/docs/
 /.idea/
 /out/
 /*.iml
+*.iml
 
 # Storage/log files
 /data/
@@ -20,3 +21,10 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+# VSCode files
+.classpath
+.project
+.settings/
+bin/
+.vscode/

README.md

@@ -1,14 +1,35 @@
-[![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.
+# NUStorage
+
+[![Java CI](https://github.com/AY2021S1-CS2103T-T11-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-T11-3/tp/actions)
+[![codecov](https://codecov.io/gh/AY2021S1-CS2103T-T11-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103T-T11-3/tp)
+
+![Logo](./docs/images/AboutUs/logo.png)
+
+---
+
+![Ui](./docs/images/Ui.png)
+
+* NUStorage is a desktop application for managing inventory, transaction records and accounts.
+* NUStorage is mainly targeted to store owners who need help in visualising what’s going on in their store easily.
+* While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+
+---
+
+## Site Map
+
+* [User Guide](./docs/UserGuide.md)
+* [Developer Guide](./docs/DeveloperGuide.md)
+* [About Us](./docs/AboutUs.md)
+
+---
+
+## Acknowledgements
+
+* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5).
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+
+---
+
+## License: [MIT](LICENSE)
+
+---

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'nustorage.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -40,6 +40,10 @@ task coverage(type: JacocoReport) {
     }
 }
 
+run {
+    enableAssertions = true
+}
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'nustorage.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -3,57 +3,77 @@ layout: page
 title: About Us
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
+We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg), formed
+to fulfill the team project requirements of [CS2103T](https://nusmods.com/modules/CS2103T/software-engineering)
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can reach us at the email `nustorage[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Prof. Damith
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/AboutUs/damithc.png" width="200px">
 
 [[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/damithc)]
 
 * Role: Project Advisor
 
-### Jane Doe
+### Eugene Teu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/AboutUs/eugeneteu.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/EugeneTeu)]
+
+* Role: Tutor
+
+
+### Tan Pinxi
+
+<img src="images/AboutUs/fizzyagent.png" width="200px">
+
+[[github](http://github.com/FizzyAgent)]
+[[portfolio](team/fizzyagent.md)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: Finance components, Testing and Documentation
+
+### Dora Heng
+
+<img src="images/AboutUs/door-oof.png" width="200px">
+
+[[github](https://github.com/Door-oof)]
+[[portfolio](team/door-oof.md)]
+
+* Role: Developer
+* Responsibilities: UI, Testing and Documentation
 
-### Johnny Doe
+### Goh Ee Liang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/AboutUs/elgoh.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/Elgoh)]
+[[portfolio](team/elgoh.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Inventory components, Testing and Documentation
 
-### Jean Doe
+### Chen Xihao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/AboutUs/howtoosee.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/howtoosee)]
+[[portfolio](team/howtoosee.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Storage components, Testing and Documentation
 
-### James Doe
+### Lim Yu Yang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/AboutUs/ironbiscuit.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/IronBiscuit)]
+[[portfolio](team/ironbiscuit.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: UI, Testing and Documentation