[CS2103T-T17-2] Traveez

.travis.yml

@@ -1,24 +1,24 @@
-language: java
-matrix:
-  include:
-    - jdk: openjdk11
-
-script: >-
-    ./config/travis/run-checks.sh &&
-    ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
-
-deploy:
-  skip_cleanup: true
-  provider: script
-  script: ./config/travis/deploy_github_pages.sh
-  on:
-    branch: master
-
-before_cache:
-  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
-  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
-
-cache:
-  directories:
-    - $HOME/.gradle/caches/
-    - $HOME/.gradle/wrapper/
+language: java
+matrix:
+  include:
+    - jdk: openjdk11
+
+script: >-
+    ./gradlew clean test coverage coveralls asciidoctor
+
+
+deploy:
+  skip_cleanup: true
+  provider: script
+  script: ./config/travis/deploy_github_pages.sh
+  on:
+    branch: master
+
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+
+cache:
+  directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/

README.adoc

@@ -1,36 +1,35 @@
-= Address Book (Level 3)
-ifdef::env-github,env-browser[:relfileprefix: docs/]
-
-https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&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]]
-
-ifdef::env-github[]
-image::docs/images/Ui.png[width="600"]
-endif::[]
-
-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.
-
-== 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_.
-* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
-
-== Licence : link:LICENSE[MIT]
+= TravEzy
+ifdef::env-github,env-browser[:relfileprefix: docs/]
+
+https://travis-ci.org/AY1920S1-CS2103T-T17-2/main[image:https://travis-ci.org/AY1920S1-CS2103T-T17-2/main.svg?branch=master[Build Status]]
+
+ifndef::env-github[]
+image::https://raw.githubusercontent.com/AY1920S1-CS2103T-T17-2/main/master/docs/images/Ui.png[width="600"]
+endif::[]
+
+Hey you! Yes you! Do you like travelling around the world but find it hard to manage your expenses while travelling abroad?
+Well then we just have the solution for you. Introducing Travezy, with Travezy, we help NUS students who love travelling plan their
+travel plans while keeping a lookout of their expenditure throughout the time. Travezy is your one stop trusty desktop
+application to organize your plans and financial needs. But wait, there's more, Travezy is optimized for those who prefer
+to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can
+type fast this is definitely the app for you! So what are you waiting for? Get your copy of Travezy today!
+
+== Site Map
+
+* <<UserGuide#, User Guide>>
+* <<DeveloperGuide#, Developer Guide>>
+* <<LearningOutcomes#, Learning Outcomes>>
+* <<AboutUs#, About Us>>
+* <<ContactUs#, Contact Us>>
+
+== Acknowledgements
+
+* The original source code is obtained from AddressBook-Level3 project by https://se-education.org[SE-EDU]
+* 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_.
+* Travezy would like to acknowledge the following awesome source code and guidance in creating this application.
+AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
+* UI is designed with the use of Flaticons
+* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+
+== Licence : link:LICENSE[MIT]

build.gradle

@@ -1,3 +1,4 @@
+
 // Gradle Configuration File
 // For more details take a look at the Java Quickstart chapter in the Gradle
 // user guide available at http://gradle.org/docs/5.2.1/userguide/tutorial_java_projects.html
@@ -25,10 +26,12 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+
 checkstyle {
     toolVersion = '8.1'
 }
 
+
 jacocoTestReport {
     reports {
         xml.enabled false
@@ -43,7 +46,7 @@ test {
 
 dependencies {
     String jUnitVersion = '5.4.0'
-    String javaFxVersion = '11'
+    String javaFxVersion = '11.0.1'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
@@ -61,13 +64,15 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
+    implementation fileTree(dir: 'lib', include: ['controlsfx-11.0.0.jar'])
+
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'TravEzy.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -133,8 +138,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level3',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level3',
+        'site-name': 'TravEzy',
+        'site-githuburl': 'https://github.com/AY1920S1-CS2103T-T17-2/main',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 
@@ -152,4 +157,4 @@ task copyStylesheets(type: Copy) {
 }
 asciidoctor.dependsOn copyStylesheets
 
-defaultTasks 'clean', 'test', 'coverage', 'asciidoctor'
+defaultTasks 'clean', 'test', 'coverage', 'asciidoctor'

docs/AboutUs.adoc

@@ -4,53 +4,59 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 3 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.}_ +
+TravEzy was developed by the https://ay1920s1-cs2103t-t17-2.github.io/main/ team. +
+
 {empty} +
 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>>]
+=== Ong Bing Jue
+image::bjhoohaha.png[width="150", align="left"]
+{empty}[https://github.com/bjhoohaha[github]]
+
+Role: Chief Operations Officer +
 
-Role: Project Advisor
+Responsibilities: Developer - Address Book
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Hon Hao Chen
+image::honhaochen.png[width="150", align="left"]
+{empty}[http://github.com/honhaochen[github]]
+
+Role: Chief Financial Officer +
 
-Role: Team Lead +
-Responsibilities: UI
+Responsibilities: Developer - Financial Tracker
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Ng Zhao Ming
+image::ngzhaoming.png[width="150", align="left"]
+{empty}[http://github.com/ngzhaoming[github]]
 
-Role: Developer +
-Responsibilities: Data
+Role: Chief Technology Officer +
+
+Responsibilities: Developer - Itinerary
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Poh Lin Wei
+image::pohlinwei.png[width="150", align="left"]
+{empty}[http://github.com/pohlinwei[github]]
+
+Role: Chief Strategy Officer +
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Developer - Calendar
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Tishya Khanna
+image::tishyakhanna97.png[width="150", align="left"]
+{empty}[http://github.com/tishyakhanna97[github]]
+
+Role: Chief Information Officer +
 
-Role: Developer +
-Responsibilities: UI
+Responsibilities: Developer - Travel Diary
 
 '''

docs/ContactUs.adoc

@@ -4,4 +4,4 @@
 
 * *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
 * *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+* *Email us* : You can also reach us at `[email protected]`