[CS2103-F08-3] StaffConnect

README.md

@@ -1,14 +1,25 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# StaffConnect
+
+[![CI Status](https://github.com/AY2324S2-CS2103-F08-3/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2324S2-CS2103-F08-3/tp/actions)
 
 ![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.
+StaffConnect offers convenience and peace of mind to a struggling student with memory recollection issues.
+This product allows users to easily identify and connect with educators by providing visual cues alongside contact
+details, supported by a quick and easy filter system. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+
+# Features:
+* Quickly add and review contacts
+* Filter and search your required contacts quickly
+* Add consultation times to the particular contact
+* View and manage your meeting times
+
+# Getting Started
+ * Ensure that at least **Java 11 with JavaFx runtime is installed**
+ * Run the the application with ```java -jar StaffConnect.jar```
+
+# Credits
+StaffConnect is an ongoing software project for a desktop application used for managing contact details.
+* For the detailed documentation of this project, see the **[StaffConnect Product Website](https://ay2324s2-cs2103-f08-3.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* 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

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

copyright.txt

@@ -1,7 +1,7 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
 Copyright by Susumu Yoshida - http://www.mcdodesign.com/
-- address_book_32.png
+- staff_connect.png
 - AddressApp.ico
 
 Copyright by Jan Jan Kovařík - http://glyphicons.com/

docs/AboutUs.md

@@ -9,51 +9,51 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Lim Xiu Jia
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tsulim.png" class="profilepic" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/tsulim)]
+[[portfolio](team/tsulim.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Scheduling and tracking
 
-### Jane Doe
+### Calista Wong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/whitesnowx.png" class="profilepic" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/whitesnowx)]
+[[portfolio](team/whitesnowx)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Documentation and organisation
 
-### Johnny Doe
+### Li Xinyi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/iynixil.png" class="profilepic" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/iynixil)] [[portfolio](team/iynixil.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Documentation Quality Assurance
 
-### Jean Doe
+### Jerry Wang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jerrywang0000.png" class="profilepic" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/JerryWang0000)]
+[[portfolio](team/jerrywang0000)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Backend Developer
+* Responsibilities: Development of Functionalities
 
-### James Doe
+### Norton Ng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/pluiexo.png" class="profilepic" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/Pluiexo)]
+[[portfolio](team/pluiexo.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Development of UI/UX and Integration, Lead

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/AY2324S2-CS2103-F08-3/tp/blob/master/src/main/java/staffconnect/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.