[CS2103T-W10-4] FoodNotes

README.md

@@ -1,14 +1,11 @@
-[![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/AY2324S1-CS2103T-W10-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-W10-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W10-4/tp/graph/badge.svg?token=ZWKAC99R4H)](https://codecov.io/gh/AY2324S1-CS2103T-W10-4/tp)
+# FoodNotes
 ![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.
+
+## Introduction
+FoodNotes is a desktop address book application used to record reviews on food stalls and menus. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+
+## Others
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).<br>

build.gradle

@@ -61,12 +61,16 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
-
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'FoodNotes.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -9,51 +9,52 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Samuel Mui
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/samuelmui8.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/samuelmui8)]
+[[portfolio](team/samuelmui8.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Backend
 
-### Jane Doe
+### Teo Kai Sheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/teoks0199.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/teoks0199)]
+[[portfolio](team/teoks0199.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Backend
 
-### Johnny Doe
+### Lim RuiZhi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ruizhi2001.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/Ruizhi2001)]
+[[portfolio](team/ruizhi2001.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UIUX
 
-### Jean Doe
+### Beatrice Chen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/beatricecst.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/beatricecst)]
+[[portfolio](team/beatricecst.md)]
 
 * Role: Developer
 * Responsibilities: Dev Ops + Threading
 
-### James Doe
+### Du Kaixuan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jamesebond.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jamesebond)]
+[[portfolio](team/jamesebond.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Best Developer
+* Responsibilities: Best UI

docs/DevOps.md

@@ -1,10 +1,9 @@
 ---
 layout: page
 title: DevOps guide
+show-toc: true
 ---
 
-* Table of Contents
-{:toc}
 
 --------------------------------------------------------------------------------------------------------------------