[CS2103T-W13-1] Networkers

LICENSE

@@ -2,11 +2,11 @@ MIT License
 
 Copyright (c) 2016 Software Engineering Education - FOSS Resources
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any client obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
+copies of the Software, and to permit clients to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all

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)
+[![Java CI](https://github.com/AY2122S2-CS2103T-W13-1/tp/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/AY2122S2-CS2103T-W13-1/tp/actions/workflows/gradle.yml)
 
 ![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
+Networkers is a **desktop app for managing contacts for networks, optimised for use via a Command Line Interface (CLI)** 
+while still having the benefits of a Graphical User Interface (GUI). 
+If you can type fast, Networkers can get your contact management tasks done faster than traditional GUI apps.
+
+## Getting Started
+Learn how to get started with Networkers by going to our 
+[User’s guide](https://ay2122s2-cs2103t-w13-1.github.io/tp/UserGuide.html).
+
+## Contributing to Networkers
+For more information on how to contribute code to our project, see our
+[Developer’s guide](https://ay2122s2-cs2103t-w13-1.github.io/tp/DeveloperGuide.html).
+
+## About the Team
+If you wish to know more about the team behind Networkers, see our 
+[About us](https://ay2122s2-cs2103t-w13-1.github.io/tp/AboutUs.html) page.
+
+## Acknowledgements
+This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.
+
+Libraries used: JavaFx, Jackson, JUnit5

build.gradle

@@ -40,6 +40,10 @@ task coverage(type: JacocoReport) {
     }
 }
 
+run {
+    enableAssertions = true
+}
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'networkers.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,58 @@ title: About Us
 
 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`
+You can reach us at the email `networkers@comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
 
-<img src="images/johndoe.png" width="200px">
+### Isaac Tan
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/iztanpy.png" width="200px">
 
-* Role: Project Advisor
+[[github](https://github.com/iztanpy)]
+[[portfolio](team/iztanpy.md)]
 
-### Jane Doe
+* Role: Developer
+* Responsibilities: Added Procedure class 
+  as well as updated and added new features
+
+### Teo Ming Huang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/teominghuang.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/teominghuang)]
+[[portfolio](team/teominghuang.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Connect Procedure to the different dependencies, and update existing AB3 commands to Networkers.
 
-### Johnny Doe
+### Alexander Er
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/aceszhenwei.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/aceszhenwei)]
+[[portfolio](team/aceszhenwei.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Update existing AB3 commands to Networkers as well as documentation
 
-### Jean Doe
+### Yong Gi Roh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/robinrojh.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/robinrojh)]
+[[portfolio](team/robinrojh.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Update new features and documentations, and manage UI-related issues
 
-### James Doe
+### JB Jungbae Kim
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jbkim1999.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jbkim1999)]
+[[portfolio](team/jbkim1999.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Code Quality, Manage PRs

docs/DevOps.md

@@ -74,7 +74,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/AY2122S2-CS2103T-W13-1/tp/blob/master/src/main/java/seedu/address/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.