[CS2103T-W10-2] StoreMando

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 item 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 items 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,18 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+
+[![CI Status](https://github.com/AY2021S2-CS2103T-W10-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S2-CS2103T-W10-2/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.
+* This is the CS2103T Project for **Team CS2103T-W10-2**, the name of the project is StoreMando.
+
+* StoreMando is an integrated platform fully customised for residents in households, residential colleges and halls, to
+  help users manage their items effectively and efficiently. StoreMando allows users to keep track of their items'
+  whereabouts, quantities and expiry dates with a few simple commands. Furthermore, StoreMando also comes with an
+  inbuilt reminder feature to help users keep track of items that are expiring. All items' information is encapsulated
+  clearly on our simple and clean Graphical User Interface (GUI). Our application is optimised for use via the Command
+  Line Interface (CLI) and if users have quick fingers, StoreMando can help users manage their items in the blink of an
+  eye.
+
+* For the detailed documentation of this project, see
+  the **[StoreMando Product Website](https://ay2021s2-cs2103t-w10-2.github.io/tp/)**.

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.storemando.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -25,6 +25,10 @@ test {
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'storemando.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,58 @@ 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
+## StoreMando Project Team
 
-### John Doe
+### Chen Yan Jia Jay
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jaychenyj.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/JayChenYJ)]
+[[portfolio](team/jaychenyj.md)]
+You can reach me at the email `[email protected]`
 
-* Role: Project Advisor
-
-### Jane Doe
+* Role: Team Lead
+* Responsibilities: Scheduling and tracking, Deliverables and deadlines
+
+### Chew Wei Hao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/chewwh09.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/chewwh09)]
+[[portfolio](team/chewwh09.md)]
+You can reach me at the email `[email protected]`
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Logic and GUI Expert
 
-### Johnny Doe
+### Mohamed Fazil
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/md-fazil.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/Md-Fazil)] [[portfolio](team/md-fazil.md)] You can reach me at the email `[email protected]`
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Documentation and Git Expert
 
-### Jean Doe
+### Kumaran S/O Selvvaratnam
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/kumsssss.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/kumsssss)]
+[[portfolio](team/kumsssss.md)]
+You can reach me at the email `[email protected]`
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Documentation and Testing Expert
 
-### James Doe
+### Amanda Ang Yee Min
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/github-amanda.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/github-amanda)]
+[[portfolio](team/github-amanda.md)]
+You can reach me at the email `[email protected]`
 
-* Role: Developer
-* Responsibilities: UI
+* Roles: Developer
+* Responsibilities: GUI and SourceTree Expert

docs/Configuration.md

@@ -3,4 +3,5 @@ layout: page
 title: Configuration guide
 ---
 
-Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
+Certain properties of the application can be controlled (e.g. user preferences file location, logging level) through the 
+configuration file (default: `config.json`).

docs/DevOps.md

@@ -10,16 +10,16 @@ title: DevOps guide
 
 ## Build automation
 
-This project uses Gradle for **build automation and dependency management**. **You are recommended to read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.
-
+This project uses Gradle for **build automation and dependency management**. **You are recommended to
+read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.
 
 Given below are how to use Gradle for some important project tasks.
 
-
 * **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).<br>
   e.g. `./gradlew clean`
 
-* **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, *if the current file is outdated*.<br>
+* **`shadowJar`**: Uses the ShadowJar plugin to create a fat JAR file in the `build/lib` folder, *if the current file is
+  outdated*.<br>
   e.g. `./gradlew shadowJar`.
 
 * **`run`**: Builds and runs the application.<br>
@@ -29,41 +29,52 @@ Given below are how to use Gradle for some important project tasks.
   **`checkstyleTest`**: Runs the code style check for the test code base.
 
 * **`test`**: Runs all tests.<
-  * `./gradlew test` — Runs all tests
-  * `./gradlew clean test` — Cleans the project and runs tests
+    * `./gradlew test` — Runs all tests
+    * `./gradlew clean test` — Cleans the project and runs tests
 
 --------------------------------------------------------------------------------------------------------------------
 
 ## Continuous integration (CI)
 
-This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the `.github/workflows` folder). No further setting up required.
+This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in
+the `.github/workflows` folder). No further setting up required.
 
 ### Code coverage
 
-As part of CI, this project uses Codecov to generate coverage reports. Here are the steps to set up CodeCov for a fork of this repository.
+As part of CI, this project uses Codecov to generate coverage reports. Here are the steps to set up CodeCov for a fork
+of this repository.
 
 1. Sign up with Codecov using your GitHub account [here](https://codecov.io/signup).
 1. Once you are inside Codecov web app, add your fork to CodeCov.
-1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.
+1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your
+   repo with it so that the
+   badge [![codecov](https://github.com/AY2021S2-CS2103T-W10-2/tp/workflows/Java%20CI/badge.svg)](https://codecov.io/gh/AY2021S2-CS2103T-W10-2/tp)
+   in that page reflects the coverage of your project.
 
 ### Repository-wide checks
 
-In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.
+In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover
+files used in the build process, these repository-wide checks cover all files in the repository. They check for
+repository rules which are hard to enforce on development machines such as line ending requirements.
 
-These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:
+These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such
+as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root
+directory:
 
 `./config/travis/run-checks.sh`
 
 Any warnings or errors will be printed out to the console.
 
 **If adding new checks:**
 
-* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.
+* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will
+  automatically pick up and run files named as such. That is, you can add more such files if you need, and the CI will
+  do the rest.
 
 * Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE`
-  * SEVERITY is either ERROR or WARN.
-  * FILENAME is the path to the file relative to the current directory.
-  * LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
+    * SEVERITY is either ERROR or WARN.
+    * FILENAME is the path to the file relative to the current directory.
+    * LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
 
 * Check scripts must exit with a non-zero exit code if any errors occur.
 
@@ -73,7 +84,9 @@ 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/AY2021S2-CS2103T-W10-2/tp/blob/master/src/main/java/seedu/storemando/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadow`).
-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.
+1. Tag the repo with the version number. e.g. `v1.5`
+1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you
+   created.