[CS2103-T16-1] UNIon

.gitignore

@@ -3,6 +3,9 @@
 /build/
 src/main/resources/docs/
 
+# Settings files
+/.settings/
+
 # IDEA files
 /.idea/
 /out/
@@ -20,3 +23,5 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+.project
+./docs/*.md.orig

README.md

@@ -1,14 +1,49 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# UNIon
+
+UNIon is a desktop application **tailored for Computing Students**,
+helping to **organise** and **navigate** the sea of
+communication-based **data** in school so that users
+can better achieve higher levels of **productivity**.
+
+### Motivation
+
+UNIon was created as a productivity application, aiming to organise school contacts for students.<br>
+The name `UNIon` came from the function of the application to
+be a collection of a groups of people designed for university students.
+
+### Build Status
+
+[![CI Status](https://github.com/AY2122S1-CS2103-T16-1/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2122S1-CS2103-T16-1/tp/actions)
+
+### Screenshots
 
 ![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.
+### Features
+
+* Add contacts to UNIon
+* Search for a mobile number of a contact
+* Update contact details
+* Delete contacts
+* Create folders for your contacts
+* Add contacts to folders
+* List all folders
+* Delete folders
+* Use Unix commands to navigate UNIon
+
+**Coming Soon...**
+* GUI window update
+* Folders saved locally
+* Find specific folders
+* Add multiple contacts at once
+* Rename folder
+
+### Built With
+
+* Java
+* JavaFX
+
+### Acknowledgement
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+

build.gradle

@@ -65,8 +65,13 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'UNIon.jar'
 }
 
 defaultTasks 'clean', 'test'
+
+run {
+    enableAssertions = true
+}

docs/AboutUs.md

@@ -3,57 +3,66 @@ layout: page
 title: About Us
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
+We believe in providing **simplicity** in everything we do here. If you're the kind of person who likes to organize your
+communication-based data easily with just a keyboard, you will enjoy UNIon. By re-purposing Unix commands, we ensure
+that you can get up to speed quickly and be productive with your data.
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+# Our Team
 
-## Project team
+## Lee Hur Sebastian
 
-### John Doe
+**Role: Team Lead**
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sebbycake.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[![Sebastian PPP](images/portfolio.png)](https://ay2122s1-cs2103-t16-1.github.io/tp/team/sebbycake.html) &nbsp;
+[![Sebastian LinkedIn](images/linkedin.png)](https://www.linkedin.com/in/sebastian-lee-329b45198/) &nbsp;
+[![Sebastian GitHub](images/github.png)](https://github.com/sebbycake)
 
-* Role: Project Advisor
+<br>
 
-### Jane Doe
+## Lye Wen Jun
 
-<img src="images/johndoe.png" width="200px">
+**Role: Code Quality**
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/xlzior.png" width="200px">
 
-* Role: Team Lead
-* Responsibilities: UI
+[![Wen Jun PPP](images/portfolio.png)](https://ay2122s1-cs2103-t16-1.github.io/tp/team/xlzior.html) &nbsp;
+[![Wen Jun LinkedIn](images/linkedin.png)](https://www.linkedin.com/in/wen-jun-lye/) &nbsp;
+[![Wen Jun GitHub](images/github.png)](https://github.com/xlzior/)
 
-### Johnny Doe
+<br>
 
-<img src="images/johndoe.png" width="200px">
+## Lee Wei, David
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+**Role: Documentation**
 
-* Role: Developer
-* Responsibilities: Data
+<img src="images/itsyme.png" width="200px">
 
-### Jean Doe
+[![David PPP](images/portfolio.png)](https://ay2122s1-cs2103-t16-1.github.io/tp/team/itsyme.html) &nbsp;
+[![David LinkedIn](images/linkedin.png)](https://www.linkedin.com/in/david-lee-4a147a1b1/) &nbsp;
+[![David GitHub](images/github.png)](https://github.com/itsyme)
 
-<img src="images/johndoe.png" width="200px">
+<br>
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+## Rehman Sajid
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+**Role: Integration**
 
-### James Doe
+<img src="images/rehmmann.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[![Rehman PPP](images/portfolio.png)](https://ay2122s1-cs2103-t16-1.github.io/tp/team/rehmmann.html) &nbsp;
+[![Rehman LinkedIn](images/linkedin.png)](https://www.linkedin.com/in/rehman-sajid/) &nbsp;
+[![Rehman GitHub](images/github.png)](https://github.com/rehmmann/)
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<br>
 
-* Role: Developer
-* Responsibilities: UI
+## Ching Jia Rong
+
+**Role: Testing**
+
+<img src="images/jiarong15.png" width="200px">
+
+[![Jia Rong PPP](images/portfolio.png)](https://ay2122s1-cs2103-t16-1.github.io/tp/team/jiarong15.html) &nbsp;
+[![Jia Rong LinkedIn](images/linkedin.png)](https://www.linkedin.com/in/jiarong15//) &nbsp;
+[![Jia Rong GitHub](images/github.png)](https://github.com/jiarong15)