[CS2103-F10-2] Bogo Bogo

README.md

@@ -2,13 +2,14 @@
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+# Bogo Bogo
+* This is an efficient CLI-based inventory management system that helps small business owners/entrepreneurs keep track it their inventory.<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.
+  * as an inventory tracker
+  * as a order checker
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC).
   * 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 `Bogobogo` because it provides fast and efficient managing of inventory just like how bogosort is.
+* For the detailed documentation of this project, see the **[BogoBogo Product Website](https://AY2122S1-CS2103-F10-2.github.io/tp)**.
+* 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.

build.gradle

@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'bogobogo.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -1,6 +1,7 @@
 ---
 layout: page
 title: About Us
+parent: The Team
 ---
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
@@ -9,51 +10,38 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Bryan Wee Shun Yi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/bryanwee023.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Project Advisor
-
-### Jane Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/bryanwee023)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: UI, Scheduling and Tracking, Git Expert
 
-### Johnny Doe
+### Hay Man Hnin Lwin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/gracewang2322.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/gracewang2322)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Documentation, Deliverables and Deadlines
 
-### Jean Doe
+### Wang Pei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/wangpeialex.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/wangpeialex)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Testing, Storage
 
-### James Doe
+### Bernardus Krishna
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/bernarduskrishna.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/bernarduskrishna)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Model, Logic

docs/Configuration.md

@@ -1,6 +1,8 @@
 ---
 layout: page
 title: Configuration guide
+parent: For Developers
+nav_order: 2
 ---
 
 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

@@ -1,25 +1,23 @@
 ---
-layout: page
-title: DevOps guide
+layout: page title: DevOps guide parent: For Developers
 ---
 
-* Table of Contents
-{:toc}
+* Table of Contents {:toc}
 
 --------------------------------------------------------------------------------------------------------------------
 
 ## 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 creat 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 +27,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://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.
 
 ### 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 +82,10 @@ 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/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/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.
+1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you
+   created.