[CS2103T-W11-2] JARVIS

.gitignore

@@ -20,3 +20,9 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+# Login details
+login.json
+
+# Debug log
+debug.log

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 student 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 students 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.md

@@ -1,14 +1,23 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-W11-2/tp/actions)
+[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103T-W11-2/tp)
 
-![Ui](docs/images/Ui.png)
+## Introduction
+**Jarvis** is a personal butler for CS1101S Avengers.
+It is named Jarvis because it is the personal assistant to CS1101S tutors who are called Avengers, just like how Jarvis is the personal assistant to Iron Man in the movie Avengers.
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
+The project simulates an ongoing software project for a desktop application (called _Jarvis_) used for managing missions and quests deadlines, students' information, consultation and mastery check timings for CS1101S tutors.
+  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 10 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
   * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+
+## Preview
+![Ui](docs/images/Ui.png)
+
+## Useful Links
+* [User Guide](https://ay2021s1-cs2103t-w11-2.github.io/tp/UserGuide.html)
+* [Developer Guide](https://ay2021s1-cs2103t-w11-2.github.io/tp/DeveloperGuide.html)
+
+## Documentation
+* For the detailed documentation of this project, see the **[Jarvis Product Website](https://ay2021s1-cs2103t-w11-2.github.io/tp/)**.
+
+## Acknowledgements
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.jarvis.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '8.29'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -44,6 +48,8 @@ dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
 
+    compile group: 'org.seleniumhq.selenium', name: 'selenium-java', version: '3.8.1'
+
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
@@ -66,7 +72,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'jarvis.jar'
 }
 
 defaultTasks 'clean', 'test'

config/checkstyle/checkstyle.xml

@@ -188,13 +188,10 @@
     <module name="NeedBraces">
       <!--
       if (true) return 1; // Not allowed
-
       if (true) { return 1; } // Not allowed
-
       else if {
         return 1; // else if should always be multi line
       }
-
       if (true)
         return 1; // Not allowed
       -->
@@ -359,14 +356,12 @@
     -->
     <module name="SingleSpaceSeparator">
       <!-- Validate whitespace surrounding comments as well.
-
            a = 1; // Allowed (single space before start of comment)
            a = 1; /* Allowed (single space before start of comment) */
            /* Allowed (single space after end of comment) */ a = 1;
            a = 1;  // Not allowed (more than one space before start of comment)
            a = 1;  /* Not allowed (more than one space before start of comment) */
            /* Not allowed (more than one space after end of comment) */  a = 1;
-
            This doesn't validate whitespace within comments so a comment /* like  this */ is allowed.
       -->
       <property name="validateComments" value="true"/>

copyright.txt

@@ -1,5 +1,11 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
+Copyright by icons8 - https://www.visualpharm.com/free-icons/user%20manual-595b40b85ba036ed117dad4e
+- user_guide.png
+
+Copyright by Source Academy - https://sourceacademy.nus.edu.sg/favicon.ico
+- source_academy.png
+
 Copyright by Susumu Yoshida - http://www.mcdodesign.com/
 - address_book_32.png
 - AddressApp.ico

docs/AboutUs.md

@@ -5,55 +5,60 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can reach us at the email `jarvis@comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Associate Professor Damith Chatura Rajapakse
 
-<img src="images/johndoe.png" width="200px">
+* Role: Lecturer, Tutor
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Wu Peirong
 
-* Role: Project Advisor
+<img src="images/peironggg.png" width="200px">
 
-### Jane Doe
+[[github](http://github.com/peironggg)]
+[[portfolio](team/peironggg.md)]
 
-<img src="images/johndoe.png" width="200px">
+* Role: Developer
+* Responsibilities: API + Student Features
+
+### Seo Yeryeon
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/wireseo.png" width="200px">
 
-* Role: Team Lead
-* Responsibilities: UI
+[[github](http://github.com/wireseo)]
+[[portfolio](team/wireseo.md)]
+
+* Role: Developer
+* Responsibilities: GUI + Consultation and Mastery Check Features
 
-### Johnny Doe
+### Wiline Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/wilinetan.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/wilinetan)]
+[[portfolio](team/wilinetan.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Mission and Quest Features + GUI
 
-### Jean Doe
+### Ng Zhen Teng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ngzhenteng.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ngzhenteng)]
+[[portfolio](team/ngzhenteng.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Student Features + Testing
 
-### James Doe
+### Lim Jun Jie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/asuraxsoul.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/asuraxsoul)]
+[[portfolio](team/asuraxsoul.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Tutor Task Features

docs/Configuration.md

@@ -3,4 +3,4 @@ layout: page
 title: Configuration guide
 ---
 
-Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
+Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (`config.json`).

docs/DevOps.md

@@ -73,7 +73,7 @@ Any warnings or errors will be printed out to the console.
 
 Here are the steps to create a new release.
 
-1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
+1. Update the version number in [`MainApp.java`](https://github.com/AY2021S1-CS2103T-W11-2/tp/blob/master/src/main/java/seedu/jarvis/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadow`).
 1. Tag the repo with the version number. e.g. `v0.1`
 1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.