[F09-3]Invités - v1.1

.gitignore

@@ -7,8 +7,7 @@ lib/*
 *.iml
 *.log
 *.log.*
-*.csv
-config.json
+/config.json
 src/test/data/sandbox/
 preferences.json
 .DS_Store

README.adoc

@@ -1,11 +1,11 @@
-= Address Book (Level 4)
+# Invités
 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]]
-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://travis-ci.org/CS2113-AY1819S1-F09-3/main[image:https://travis-ci.org/CS2113-AY1819S1-F09-3/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/aaryamNUS/main[image:https://ci.appveyor.com/api/projects/status/bdt6xr7o98ea332r?svg=true[Build status]]
+https://coveralls.io/github/CS2113-AY1819S1-F09-3/main?branch=master[image:https://coveralls.io/repos/github/CS2113-AY1819S1-F09-3/main/badge.svg?branch=master[Coverage Status]]
 https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+https://cs2113-ay1819s1-f09-3.github.io/main/[image:https://img.shields.io/badge/Documentation-Online-green.svg[Documentation Link]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,27 +15,53 @@ 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.
 
-== Site Map
+Invités is desktop application that caters to organisers of different events (such as weddings, orientation camps, networking sessions, product launches, etc). It helps event planners reduce their workload during the planning phase by providing them
+a convenient platform to manage guest lists, organise catering services, as well as keep track of payments. Our main target audience are event managers and planners, who wish to utilise a streamlined and efficient approach towards organising their
+events.
 
-* <<UserGuide#, User Guide>>
-* <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
-* <<AboutUs#, About Us>>
-* <<ContactUs#, Contact Us>>
+## Our Purpose
+To streamline, digitise, and revamp the process of managing events, and benefit both the guests and the planners by doing so.
 
-== Acknowledgements
+### Features:
+The following list highlights the main features our application provides, ranging from mass messaging to all guests to payment and dietary tracking.
 
-* 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://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
 
-== Licence : link:LICENSE[MIT]
+###### __For an event __
 
+1. *Overarching detail fields*
+
+    a. Name of event
+
+    b. Date and Time of event
+
+    c. Venue of event
+
+    d. Dress code for event
+
+    e. Number of guests so far
+
+    f. Number of days to event
+
+
+2. *Table of details of guests*
+
+    a. Name of guest
+
+    b. Mobile number of guest
+
+    c. Email address of guest
+
+    d. Dietary Requirement of guest
+
+    e. Ticket number of guest for mass attendance-marking
+
+    f. Status of guest (e.g. VIP)
+
+    g. Status of Payment of guest (e.g. PAID)
+
+## Acknowledgements
+Some parts of this application were adapted from the sample application: https://github.com/se-edu/addressbook-level4[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], https://mvnrepository.com/artifact/com.google.zxing/core[ZXing core], https://javaee.github.io/javamail/docs/api/[JavaMail API], https://mvnrepository.com/artifact/commons-io/commons-io[Apache Commons IO]
+### Licence : link:LICENSE[MIT]

_reposense/config.json

@@ -0,0 +1,30 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "SandhyaGopakumar",
+      "displayName": "SAN...MAR",
+      "authorNames": ["SANDHYA\\sandh", "SandhyaGopakumar"]
+    },
+    {
+      "githubId": "SarahTaaherBonna",
+      "displayName": "SAR...NNA",
+      "authorNames": ["SarahTaaherBonna"]
+    },
+    {
+      "githubId": "aaryamNUS",
+      "displayName": "SRI...YAM",
+      "authorNames": ["aaryamNUS"]
+    },
+    {
+      "githubId": "kronicler",
+      "displayName": "TAN...ANG",
+      "authorNames": ["kronicler"]
+    },
+    {
+      "githubId": "wm28",
+      "displayName": "TAN...ING",
+      "authorNames": ["wm28"]
+    }
+  ]
+}

build.gradle

@@ -75,10 +75,26 @@ dependencies {
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
+    // https://mvnrepository.com/artifact/commons-io/commons-io
+    testImplementation group: 'commons-io', name: 'commons-io', version: '2.4'
+
     testRuntimeOnly group: 'org.testfx', name: 'testfx-internal-java9', version: testFxVersion
     testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: 'jdk-9+181'
     testRuntimeOnly group:'org.junit.vintage', name:'junit-vintage-engine', version: jUnitVersion
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    // https://mvnrepository.com/artifact/javax.mail/mail
+    compile group: 'javax.mail', name: 'mail', version: '1.4.5'
+
+    // https://mvnrepository.com/artifact/javax.activation/activation
+    compile group: 'javax.activation', name: 'activation', version: '1.1.1'
+
+    // https://mvnrepository.com/artifact/com.google.zxing/core
+    compile 'com.google.zxing:core:3.3.3'
+
+    // https://mvnrepository.com/artifact/com.google.zxing/javase
+    compile 'com.google.zxing:javase:3.3.3'
+
 }
 
 shadowJar {
@@ -126,7 +142,7 @@ nonGuiTests.dependsOn test
 task(allTests)
 
 // `allTests` implies both `guiTests` and `nonGuiTests`
-allTests.dependsOn guiTests
+// allTests.dependsOn guiTests
 allTests.dependsOn nonGuiTests
 
 test {
@@ -207,8 +223,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': 'Invités',
+        'site-githuburl': 'https://github.com/CS2113-AY1819S1-F09-3/addressbook-level4',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

docs/AboutUs.adoc

@@ -4,53 +4,53 @@
 :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} +
+Invités was developed by the CS2113T AY18/19 F09-3 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>>]
+=== Srivastava Aaryam
+image::aaryamnus.png[width="150", align="left"]
+{empty}[http://github.com/aaryamNUS[github]] [<<aaryamnus#, portfolio>>]
 
-Role: Project Advisor
+Role: Team lead +
+Responsibilities: Mass email communication
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Sandhya Gopakumar
+image::sandhyagopakumar.png[width="150", align="left"]
+{empty}[http://github.com/SandhyaGopakumar[github]] [<<sandhyagopakumar#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Developer +
+Responsibilities: Event details management
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Sarah Taaher Bonna
+image::sarahtaaherbonna.png[width="150", align="left"]
+{empty}[http://github.com/SarahTaaherBonna[github]] [<<sarahtaaherbonna#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: Guest list management
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Tan Tze Guang
+image::kronicler.png[width="150", align="left"]
+{empty}[http://github.com/kronicler[github]] [<<kronicler#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Attendance management
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Tan Wei Ming
+image::wm28.png[width="150", align="left"]
+{empty}[http://github.com/wm28[github]] [<<wm28#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Data sharing
 
 '''