Skill Feature [WIP] and some docs updates

README.adoc

@@ -1,11 +1,9 @@
-= Address Book (Level 4)
+= NUSSU Connect
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/nusCS2113-AY1819S1/addressbook-level4[image:https://travis-ci.org/nusCS2113-AY1819S1/addressbook-level4.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
-https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+https://travis-ci.org/CS2113-AY1819S1-F09-1/main[image:https://travis-ci.org/CS2113-AY1819S1-F09-1/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/Chocological/main-64rse[image:https://ci.appveyor.com/api/projects/status/rge5q76v8xnskc7p/branch/master?svg=true[Build status]]
+https://coveralls.io/github/CS2113-AY1819S1-F09-1/main?branch=master[image:https://coveralls.io/repos/github/CS2113-AY1819S1-F09-1/main/badge.svg?branch=master[Coverage Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,27 +13,49 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
-* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
-** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
+
+NUSSU-Connect is an application designed and created specifically for executive committee (exco) members of the NUS Student Union (NUSSU).
+It enables the committee members to reduce their daily workload and the organisation to potentially minimize manpower and logistics issues
+during peak periods of activity by providing them a convenient platform to manage recruitment, contacts, budgets and projects efficiently.
+The application can also be used by every organisation with various departments, and a clearly defined hierarchy of roles and
+responsibilities of each and every member belonging to the organisation.
+
+== Value Proposition
+To digitise any company's or organisation's standard operating procedures, through the process of streamlining workflow to essentially
+solve, or at least minimize, any manpower and logistics issues that can happen during any peak periods of business activities.
+
+=== Notable features
+The list shown below details the key features that our application provides, which any organisation or company can make full use of.
+
+* Security:
+** Log into the application with a set of login credentials
+*** Gives a specific level of access to the application according to role of user account defined during account creation
+** Creation of a new account with desired login credentials for logging into the application
+
+* Recruitment / HR
+** Attach skills to the people in your organization.
+** Order them by certain parameters to organize information more easily.
+
+* Financial Logistics Management:
+** Club Members can submit the budget calculation data for the calculation and allocation of their club's budget
+** NUSSU Treasurers can calculate and allocate the final budgets to all the clubs based on the total available budget
+** Users can view the final budget allocated to each club
+* Easy Management of Contact Information:
+** Users can utilize the search pruning feature to search through a large database of contacts efficiently.
+** Advanced search commands gives users extra flexibility when performing their search
+
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
-* <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
-* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
-_Marco Jakob_.
+* Some parts of this application were inspired and adapted from the sample application: Address Book Level 4 by SE-EDU.
 * Libraries used: https://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
+* The original source of the code is https://github.com/se-edu/[AddressBook-Level4] project created by SE-EDU initiative.
 
 == Licence : link:LICENSE[MIT]
 

build.gradle

@@ -82,7 +82,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'NUSSU-Connect.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -126,7 +126,7 @@ nonGuiTests.dependsOn test
 task(allTests)
 
 // `allTests` implies both `guiTests` and `nonGuiTests`
-allTests.dependsOn guiTests
+//allTests.dependsOn guiTests
 allTests.dependsOn nonGuiTests
 
 test {
@@ -207,8 +207,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level4',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
+        'site-name': 'NUSSU Connect',
+        'site-githuburl': 'https://github.com/CS2113-AY1819S1-F09-1/NUSSU-Connect',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

docs/AboutUs.adoc

@@ -4,53 +4,48 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
+image::NUSSU-ConnectPNGBanner.png[width="800", align=center"]
+NUSSU-Connect is an application developed to help NUSSU manage people and
+related functions relating to HR and Finance needs. It is currently a work in progress and is developed by
+https://se-edu.github.io/docs/Team.html[F09-1] team. +
+
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
-
-Role: Project Advisor
-
-'''
+=== Boon Jun
+image::ladderinc.png[width="150", align="left"]
+{empty}[http://github.com/ladderinc[github]][<<ladderinc#, portfolio>>]
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Scheduling and Tracking, Deliverables and deadlines +
+Responsibilities: Search Pruning + Advanced Search and filter feature.
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Melvin Tan
+image::chocological.png[width="150", align="left"]
+{empty}[http://github.com/Chocological[github]][<<chocological#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Integration and Testing +
+Responsibilities: Login System
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Jonathan Ng
+image::derpyplops.png[width="150", align="left"]
+{empty}[http://github.com/derpyplops[github]][<<derpyplops#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Documentation and Team Lead +
+Responsibilities: HR & Roles
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Sanjukta Saha
+image::sanjukta99.png[width="150", align="left"]
+{empty}[http://github.com/sanjukta99[github]][<<sanjukta99#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: Code Quality +
+Responsibilities: Budgeting functionality
 
 '''