[CS2103T-W14-4] EventfulNUS

.gitignore

@@ -21,3 +21,4 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+/plantuml.jar

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/AY2425S1-CS2103T-W14-4/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2425S1-CS2103T-W14-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2425S1-CS2103T-W14-4/tp/graph/badge.svg?token=0K30EFA4RC)](https://codecov.io/gh/AY2425S1-CS2103T-W14-4/tp)
 
 ![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/#contributing-to-se-edu) for more info.
+**<h2>🦁 EventfulNUS is every sports event organiser's handy contact manager! 🏆</h2>**
+
+**All event organizers will be able to:**
+- 🏀 View what kind of participant each contact is in the application is without having to dig through paperwork / NUSync.
+- 🏊 View how participants are grouped by membership (e.g. faculty sports team) without having to dig through paperwork / NUSync.
+- 🎾 Track the particular participant’s involvement in the event’s sub-events (e.g. IFG has multiple sub-events that stakeholders can take part in) without having to dig through paperwork / NUSync.
+
+While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+
+* If you are interested in using EventfulNUS, head over to the [_Quick Start_ section of the **User Guide**](https://ay2425s1-cs2103t-w14-4.github.io/tp/UserGuide.html#quick-start).
+* If you are interested in contributing EventfulNUS, the [**Developer Guide**](https://ay2425s1-cs2103t-w14-4.github.io/tp/DeveloperGuide.html) is a good place to start.
+
+
+**Acknowledgements**
+
+* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.eventfulnus.Main'
 
 sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
@@ -60,13 +60,18 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     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 = 'eventfulnus.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -3,57 +3,64 @@ layout: page
 title: About Us
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
+We are W14 Team 4 formed for the [National University of Singapore School of Computing](https://www.comp.nus.edu.sg)'s
+CS2103T Software Engineering course!
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can reach us at the following emails:
+- `e1290028@u.nus.edu`
+- `youngseopark@u.nus.edu`
+- `bryanchew@u.nus.edu`
+- `e1136836@u.nus.edu`
+- `e1155464@u.nus.edu`
 
-## Project team
+## EventfulNUS Team
 
-### John Doe
+### Aaron Sim
 
-<img src="images/johndoe.png" width="200px">
+<img src="https://ay2425s1-cs2103t-w14-4.github.io/tp/images/peanuts359.png" alt="Aaron's picture" width="200px" />
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](https://github.com/peanuts359)]
+[[About Me](team/peanuts359.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Documentation, Code Quality
 
-### Jane Doe
+### Leonardo Wolf
 
-<img src="images/johndoe.png" width="200px">
+<img src="https://ay2425s1-cs2103t-w14-4.github.io/tp/images/leowolf275.png" alt="Leonardo Wolf's picture" width="200px" />
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](https://github.com/leowolf275)]
+[[About Me](team/leowolf275.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Dev Ops, Tracking
 
-### Johnny Doe
+### Youngseo Park
 
-<img src="images/johndoe.png" width="200px">
+<img src="https://ay2425s1-cs2103t-w14-4.github.io/tp/images/youngseopark05.png" alt="Youngseo Park's picture" width="200px" />
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[Github](http://github.com/youngseopark05)]
+[[About Me](team/youngseopark05.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Developer, Designer
+* Responsibilities: UI, Scheduling and Tracking
 
-### Jean Doe
+### Bryan Chew
 
-<img src="images/johndoe.png" width="200px">
+<img src="https://ay2425s1-cs2103t-w14-4.github.io/tp/images/bryanjhc.png" alt="Bryan Chew's picture" width="200px" />
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/bryanjhc)]
+[[About Me](team/bryanjhc.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Tagging and Filtering, Testing
 
-### James Doe
+### Eddy Fan
 
-<img src="images/johndoe.png" width="200px">
+<img src="https://ay2425s1-cs2103t-w14-4.github.io/tp/images/kaoxi998533.png" alt="Eddy Fan's picture" width="200px" />
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/kaoxi998533)]
+[[About Me](team/kaoxi998533.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Integration, Documentation