[CS2103-W14-3] Bamboo

README.md

@@ -1,14 +1,22 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2021S1-CS2103-W14-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-W14-3/tp/actions)
 
+# Introduction to Bamboo
+**Bamboo** is a brown-field software engineering team project based on the
+[AddressBook Level 3 (AB3)](https://github.com/se-edu/addressbook-level3) architecture, aimed at providing college students with a
+simple and accessible solution to **personal finance management**.
+
+## App Preview
 ![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.
+## Useful Links
+### Features and User Guide
+Refer to the [User Guide](docs/UserGuide.md) for a detailed walk-through of how to use Bamboo.
+
+### Developer Guide
+Interested in contributing to Bamboo? The [Developer Guide](docs/DeveloperGuide.md) is a good place to start.
+
+### About Us
+Find out more about us [here](docs/AboutUs.md).
+
+## Acknowledgements
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.expense.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '8.29'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'expensebook.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,61 @@ 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`
+You can reach us through our respective emails.
 
 ## Project team
 
-### John Doe
+### Maxx Chan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/maxxyh.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/maxxyh)]
+[[portfolio](team/maxxyh.md)]
+[[email](mailto:[email protected])]
 
-* Role: Project Advisor
+* Role: Team Lead, Developer
+* Responsibilities: Scheduling and Tracking, Deliverables and Deadlines
 
-### Jane Doe
+### Hakiem Rasid
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hakiem526.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/hakiem526)]
+[[portfolio](team/hakiem526.md)]
+[[email](mailto:[email protected])]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Testing
 
-### Johnny Doe
+### Jaylen Lee
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jaylenlee.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/Jaylenlee)]
+[[portfolio](team/jaylenlee.md)]
+[[email](mailto:[email protected])]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Integration
 
-### Jean Doe
+### Leben Chew
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lebencwb.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/lebencwb)]
+[[portfolio](team/lebencwb.md)]
+[[email](mailto:[email protected])]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: UI/UX
 
-### James Doe
+### Marcus Ng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/marcus2k.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/marcus2k)]
+[[portfolio](team/marcus2k.md)]
+[[email](mailto:[email protected])]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Code Quality

docs/DevOps.md

@@ -44,7 +44,7 @@ As part of CI, this project uses Codecov to generate coverage reports. Here are
 
 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/AY2021S1-CS2103-W14-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103-W14-3/tp) in that page reflects the coverage of your project.
 
 ### Repository-wide checks
 
@@ -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/AY2021S1-CS2103-W14-3/tp/tree/master/src/main/java/seedu/expense/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.