[CS2103T-F11-1] Hackathon HR Manager

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+## Description
+<!--
+Describe the pull request and what it does
+1. What is this implementing
+2. How is it being implemented
+3. Why is this being implemented
+-->
+
+## Checks
+- [] No errors when running the tests
+- [] Build and checkstyle passes
+- [] Run the app and ran 2 commands without failing
+- [] Written the baseline test cases for the PR
+
+## Changelog
+- []
+- []
+- []
+
+## Comments for Reviewer (if any)

.gitignore

@@ -14,8 +14,27 @@ src/main/resources/docs/
 /preferences.json
 /*.log.*
 
+# Build files
+bin/
+
+# Local Intellij settings
+.settings
+.classpath
+.project
+
 # Test sandbox files
 src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
+
+# More IDEA files
+.classpath
+.project
+.settings
+
+# Binaries
+bin/
+
+# Export files
+AlfredData/

.travis.yml

@@ -7,6 +7,9 @@ script: >-
     ./config/travis/run-checks.sh &&
     ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
 
+after_success:
+   sh ./codecov.sh
+
 deploy:
   skip_cleanup: true
   provider: script

README.adoc

@@ -1,11 +1,13 @@
-= Address Book (Level 3)
+= Alfred: The Hackathon Butler
 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]]
+https://travis-ci.com/AY1920S1-CS2103T-F11-1/main[image:https://travis-ci.com/AY1920S1-CS2103T-F11-1/main.svg?branch=master[Build Status]]
+https://app.netlify.com/sites/alfred-the-hackathon-butler/deploys[image:https://api.netlify.com/api/v1/badges/fa789a98-6a94-45b4-80c6-ea8807ad74b1/deploy-status[Netlify Status]]
+https://codecov.io/gh/AY1920S1-CS2103T-F11-1/main[image:https://codecov.io/gh/AY1920S1-CS2103T-F11-1/main/branch/master/graph/badge.svg[codecov]]
+
+**Alfred isn't just for Batman. He's for all you Hackathon Organisers out there, too!**
+[quote, Alfred Pennyworth, The Dark Knight]
+Will you be wanting the Batpod, sir?
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,21 +17,21 @@ 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.
+* Targeting the Human Resource Managers tasked with organising and managing Hackathons, Alfred is a Desktop application meant to make the job easier.
+* The application provides a quick, simple and intuitive interface to manage the logistics and administrative details behind Hackathons.
+* The application has a Graphical User Interface, but most of the user interactions happen using a CLI (Command Line Interface)
 
 == 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
+* The origin of this codebase is the AddressBook-Level3 project, created by SE-EDU initiative at https://se-education.org
+* Some parts of this sample application for AddressBook-Level3 were in turn 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]
 

build.gradle

@@ -15,14 +15,17 @@ plugins {
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.Main'
+application {
+    mainClassName = 'seedu.address.Main'
+}
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
 
 repositories {
     mavenCentral()
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
+    jcenter()
 }
 
 checkstyle {
@@ -64,10 +67,15 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    compile "org.mockito:mockito-core:2.+"
+    compile "de.jensd:fontawesomefx-fontawesome:4.7.0-11"
+    compile 'com.jfoenix:jfoenix:9.0.8'
+    compile 'com.jfoenix:jfoenix:8.0.8'
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'alfred.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -120,22 +128,22 @@ asciidoctor {
     outputDir "${buildDir}/docs"
 
     options = [
-        template_dirs: [file("${sourceDir}/templates")],
+            template_dirs: [file("${sourceDir}/templates")],
     ]
 
     attributes = [
-        linkcss: true,
-        stylesheet: 'gh-pages.css',
-        'source-highlighter': 'coderay',
-        icons: 'font',
-        experimental: true,
-        sectlinks: true,
-        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)
+            linkcss: true,
+            stylesheet: 'gh-pages.css',
+            'source-highlighter': 'coderay',
+            icons: 'font',
+            experimental: true,
+            sectlinks: true,
+            idprefix: '',  // for compatibility with GitHub preview
+            idseparator: '-',
+            'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
+            'site-name': 'Alfred',
+            'site-githuburl': 'https://github.com/AY1920S1-CS2103T-F11-1/main',
+            'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 
     options['template_dirs'].each {

codecov.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+curl -s https://codecov.io/bash > .codecov
+chmod +x .codecov
+./.codecov
+

codecov.yml

@@ -0,0 +1,12 @@
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+  status:
+    project: yes
+    patch: yes
+    changes: no
+
+ignore:
+  - "src/main/java/seedu/address/ui/.*"

config/checkstyle/checkstyle.xml

@@ -149,7 +149,7 @@
     LENGTH and CODING CHECKS
     -->
 
-    <!-- Checks that array type declarations follow Java Style
+    <!-- Checks that array commandType declarations follow Java Style
       Java style: public static void main(String[] args) // Allowed
       C style:    public static void main(String args[]) // Not allowed
     -->
@@ -310,7 +310,7 @@
     </module>
 
     <module name="OperatorWrap">
-      <!-- Checks that the non-assignment type operator is at the next line in a line wrap.
+      <!-- Checks that the non-assignment commandType operator is at the next line in a line wrap.
            This includes "?", ":", "==", "!=", "/", "+", "-", "*", "%", ">>", ">>>",
            ">=", ">", "<<", "<=", "<", "^", "|", "||", "&", "&&", "instanceof",
            "&" when used in a generic upper or lower bounds constraints,
@@ -323,7 +323,7 @@
       <property name="option" value="nl"/>
     </module>
     <module name="OperatorWrap">
-      <!-- Checks that the assignment type operator is at the previous end of line in a line wrap.
+      <!-- Checks that the assignment commandType operator is at the previous end of line in a line wrap.
            This includes "=", "/=", "+=", "-=", "*=", "%=", ">>=", ">>>=", "<<=", "^=", "&=".
       -->
       <property name="tokens" value="ASSIGN, DIV_ASSIGN, PLUS_ASSIGN, MINUS_ASSIGN, STAR_ASSIGN, MOD_ASSIGN,

config/travis/check-trailing-whitespace.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 # Checks for trailing whitespace
 
-git grep --cached -I -n --no-color -P '[ \t]+$' -- ':/' |
+git grep -I -n --no-color -P '[ \t]+$' -- ':/' |
 awk '
     BEGIN {
         FS = ":"

docs/AboutUs.adoc

@@ -4,53 +4,56 @@
 :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.}_ +
+AddressBook3 (AB3) was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
+We morphed the project into Alfred - an app that is to be used by Hackathon HR managers to manage
+and organise Hackathons. This project was developed by group F11 of CS2103T. Our team repo can be found
+https://github.com/AY1920S1-CS2103T-F11-1/main[here]. +
 {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>>]
+=== Abhiman Yadav
+image::abhiman2211.png[width="150", align="left"]
+{empty}[http://github.com/Abhiman2211[github]] [https://github.com/AY1920S1-CS2103T-F11-1/main/blob/master/docs/team/abhimanyadav.adoc[portfolio]]
 
-Role: Project Advisor
+Role: Product Design +
+Responsibilities: Parser, Scoring Feature, Team Ranking Feature
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Brian Yen
+image::brianyenna.png[width="150", align="left"]
+{empty}[http://github.com/brianyenna[github]] [<<brianyen#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Documentation +
+Responsibilities: Storage, Undo/Redo Feature, Command History Navigation Feature
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Joanna Yap
+image::joanna-yja.png[width="150", align="left"]
+{empty}[http://github.com/Joanna-YJA[github]] [<<joannayap#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Quality Assurance +
+Responsibilities: UI
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== John Min
+image::john0227.png[width="150", align="left"]
+{empty}[http://github.com/john0227[github]] [<<johnmin#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Code Quality +
+Responsibilities: Command
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Joshua Wong
+image::hcwong.png[width="150", align="left"]
+{empty}[http://github.com/hcwong[github]] [<<joshuawong#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: Project Management + Git Master +
+Responsibilities: Model + Entity
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,7 @@
 :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/AY1920S1-CS2103T-F11-1/main/issues[issue tracker]
+   if you noticed bugs or have suggestions on how to improve Alfred.
 * *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 through mailto:kyungho.min@u.nus.edu[this email]

docs/DevOps.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= Alfred - 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/AY1920S1-CS2103T-F11-1/main/tree/master
 
 == Build Automation