[W13-2] ClubManager

README.adoc

@@ -1,7 +1,17 @@
-= Address Book (Level 4)
+
+= ClubManager
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
+ifdef::env-github[]
+image::docs/images/clubmanager.png[width="200"]
+endif::[]
+
+ifndef::env-github[]
+image::images/clubmanager.png[width="200"]
+endif::[]
+
+
+https://travis-ci.org/cs2103-ay1819s2-w13-2/main[image:https://travis-ci.org/cs2103-ay1819s2-w13-2/main.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]]
@@ -14,24 +24,42 @@ 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.
+ifdef::env-github[]
+image::docs/images/Ui2.png[width="600"]
+endif::[]
+
+ifndef::env-github[]
+image::images/Ui2.png[width="600"]
+endif::[]
+
+== What is ClubManager?
+* ClubManager is an *exciting and revolutionary* desktop application for CCA management. It comes with a GUI but
+most of the user interactions takes place on the CLI (Command Line Interface) provided.
+
+== Our Target Users
+* ClubManager is specially designed for *CCA main committee members* to manage their CCA data.
+It is the go-to application for CCA leaders who are looking for a software that
+allows them to *seamlessly manage their members and activities*.
+
+== Features
+* This app comes with a laconic UI and the following features:
+** Switch from Member Management Mode to Activity Mode.
+** Add, delete, edit, filter, find, list, select, sort and manage members' information.
+** Add, delete, filter, find, list, select, update, and manage activities.
+** Add and delete member from activity
+** Display activities attended by member.
+** Export.
+
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
-
+* This application is based on https://github.com/nus-cs2103-AY1819S1/addressbook-level4[AddressBook Level 4].
 * 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_.
 * Libraries used: https://github.com/TestFX/TestFX[TextFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]

build.gradle

@@ -77,7 +77,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'clubmanager.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -202,8 +202,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': 'Club-Manager',
+        'site-githuburl': 'https://github.com/cs2103-ay1819s2-w13-2/main',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

docs/AboutUs.adoc

@@ -4,53 +4,61 @@
 :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} +
+ClubManager was developed by team w13-2. This application builds on the existing work of the
+https://se-edu.github.io/docs/Team.html[se-edu] 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>>]
+=== Chan Ming En Minern
+image::minernchan.png[width="150", align="left"]
+{empty}[http://github.com/minernchan[github]] [<<minernchan#, portfolio>>]
 
-Role: Project Advisor
+Role: Developer (Testing) +
+Responsibilities:
 
-'''
+* In charge of Model.
+* Working on Activity Management feature.
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+'''
 
-Role: Team Lead +
-Responsibilities: UI
+=== Joel 
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Kevin Yeong Yu Heng
+image::A0143487X-Kevin.png[width="150", align="left"]
+{empty}[http://github.com/A0143487X-Kevin[github]] [<<A0143487X-Kevin#, portfolio>>]
+
+Role: Developer (Integrator) +
+Responsibilities:
 
-Role: Developer +
-Responsibilities: Data
+* In charge of UI.
+* Development of mode of operation architecture and feature.
+* Working on file handling and export features.
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Melissa Khoo Wan Xuan
+image::melkwx.png[width="150", align="left"]
+{empty}[http://github.com/melkwx[github]] [<<melkwx#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Developer (Code Quality) +
+Responsibilities:
+
+* In charge of Logic.
+* Working on Member Management feature.
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Yang Yiqing
+image::ivyyangyq.png[width="150", align="left"]
+{empty}[http://github.com/ivyyangyq[github]] [<<ivyyangyq#, portfolio>>]
+
+Role: Team Lead +
+Responsibilities:
 
-Role: Developer +
-Responsibilities: UI
+* In charge of Storage.
+* Working on Activity Management feature.
 
 '''