[CS2103T-F09-4] Volant

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 trip 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 trips 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.adoc

@@ -1,23 +1,18 @@
-= 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]]
-
-
-ifdef::env-github[]
-image::docs/images/Ui.png[width="600"]
+ifndef::env-github[]
+image::images/volantLogo.jpg[width="500px"]
 endif::[]
 
+https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/AY1920S2-CS2103T-F09-4/main.svg?branch=master[Build Status]]
+image:https://api.codacy.com/project/badge/Grade/88d0a6f6f3d54309a5fd560383e7f780[link="https://app.codacy.com/gh/AY1920S2-CS2103T-F09-4/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S2-CS2103T-F09-4/main&utm_campaign=Badge_Grade_Dashboard"]
+
 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.
+* This is a simple travel planning application to assist beginner solo travellers with the logistics of their travels.
+* It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
+* It is  written in Java 11 using object oriented programming.
 
 == Site Map
 
@@ -29,8 +24,7 @@ endif::[]
 
 == 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_.
+* This application's base code is based off the Address Book application developed by the CS2103T team for the CS2103T software engineering module.
 * 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

@@ -67,8 +67,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
-
+    archiveName = 'volant.jar'
     destinationDir = file("${buildDir}/jar/")
 }
 
@@ -133,9 +132,9 @@ 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-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
+        'site-name': 'Volant by CS2103T-F09-4',
+        'site-githuburl': 'https://github.com/AY1920S2-CS2103T-F09-4/main',
+        /*'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)*/
     ]
 
     options['template_dirs'].each {

docs/AboutUs.adoc

@@ -4,53 +4,55 @@
 :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.}_ +
-{empty} +
+Volant was developed by us. +
+
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
+Learn more about us below.
+
 == 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>>]
+=== Ranice Tan
+image::raniceyue.png[width="150", align="left"]
+{empty}[https://github.com/raniceyue[github]] [<<raniceyue#, portfolio>>]
 
-Role: Project Advisor
+Role: Team Lead +
+Responsibilities:
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Grant Lee
+image::grrrrnt.png[width="200", align="left"]
+{empty}[https://github.com/grrrrnt[github]] [<<grrrrnt#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Developer +
+Responsibilities:
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Zeke Soh
+image::zsoh97.png[width="200", align="left"]
+{empty}[https://github.com/zsoh97[github]] [<<zsoh97#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities:
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Vu Hieu Nguyen
+image::vuhieunguyen.png[width="200", align="left"]
+{empty}[https://github.com/vuhieunguyen[github]] [<<vuhieunguyen#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities:
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Mikhail Faiz
+image::mikhailfaiz.png[width="200", align="left"]
+{empty}[https://github.com/mikhailfaiz[github]] [<<mikhailfaiz#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities:
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,5 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *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.
+* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S2-CS2103T-F09-4/main/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`

docs/DevOps.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= Volant - Dev Ops
 :site-section: DeveloperGuide
 :toc:
 :toc-title:
@@ -12,7 +12,7 @@ ifdef::env-github[]
 :note-caption: :information_source:
 :warning-caption: :warning:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
+:repoURL: https://github.com/AY1920S2-CS2103T-F09-4/main
 
 == Build Automation
 
@@ -34,7 +34,7 @@ When a pull request has changes to asciidoc files, you can use https://www.netli
 
 Here are the steps to create a new release.
 
-.  Update the version number in link:{repoURL}/src/main/java/seedu/address/MainApp.java[`MainApp.java`].
+.  Update the version number in link:{repoURL}/src/main/java/seedu/location/MainApp.java[`MainApp.java`].
 .  Generate a JAR file <<UsingGradle#creating-the-jar-file, using Gradle>>.
 .  Tag the repo with the version number. e.g. `v0.1`
 .  https://help.github.com/articles/creating-releases/[Create a new release using GitHub] and upload the JAR file you created.