[CS2103-W17-3] BookCoin To The Moon

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)
+[![CI Status](https://github.com/AY2021S2-CS2103-W17-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S2-CS2103-W17-3/tp/actions)
+[![codecov](https://codecov.io/gh/AY2021S2-CS2103-W17-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S2-CS2103-W17-3/tp)
+
+# BookCoin
+
+**BookCoin (To The Moon)** is a CLI facility management system which allows users to manage bookings and presents users a structured and detailed information on facility availability. If you can type fast, BookCoin can get your facility management tasks done faster than traditional GUI apps!
+<br>
 
 ![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.
+  <br>
+Our targeted users are administrative personnels of schools or organisations who need to manage bookings and usage of a large number of facilities. They have to ensure that bookings and usages of facilities abide by restrictions in addition to checking that the bookings are valid.
+  <br>
+
+## More Details
+
+For the detailed documentation of this project, see the **[BookCoin Website](https://ay2021s2-cs2103-w17-3.github.io/tp/)**.
+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.
+
+## Acknowledgements
+We would like to extend our gratitude to two past student projects, ResiReg (AY20/21 Sem 1) and Modulo (AY19/20 Sem 2). When we came up with ideas on the direction to take our project, we evaluated their possibility and feasibility by looking at groups which have previously implemented similar ideas before proceeding with our own implementation.

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.booking.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'bookingapp.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -3,57 +3,56 @@ layout: page
 title: About Us
 ---
 
+Bookcoin (to the Moon) was developed by the team CS2103-W17-3.
 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
+### Wang Xuanqi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/xuanqi966.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/xuanqi966)]
+[[portfolio](team/xuanqi966.md)]
 
-* Role: Project Advisor
+* Role: Developer, team lead
+* Responsibilities:
 
-### Jane Doe
+### Ni Jiaying
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ninijiaying.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ninijiaying)]
+[[portfolio](team/ninijiaying.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer, integration
+* Responsibilities:
 
-### Johnny Doe
+### Vanessa Tay
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/vvan-essa.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/vvan-essa)] [[portfolio](team/vvan-essa.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Developer, deliverables and deadlines
+* Responsibilities:
 
-### Jean Doe
+### Ho Jie Feng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hojiefeng.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/hojiefeng)]
+[[portfolio](team/hojiefeng.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Developer, code quality
+* Responsibilities:
 
-### James Doe
+### Wu Weiming
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ming-00.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ming-00)]
+[[portfolio](team/ming-00.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Developer, documentation
+* Responsibilities:

docs/DevOps.md

@@ -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/AY2021S2-CS2103-W17-3/tp/tree/master/src/main/java/seedu/booking/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.