[T13-1]Tutor Pal

.gitignore

@@ -18,3 +18,6 @@ classes/
 /bin/
 src/main/resources/docs/
 out/
+
+# https://github.com/nus-cs2103-AY1819S1/forum/issues/74 Allow _reposense/config.json
+!_reposense/config.json

README.adoc

@@ -1,10 +1,10 @@
-= Address Book (Level 4)
+= TutorPal
 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.com/CS2103-AY1819S1-T13-1/main[image:https://travis-ci.com/CS2103-AY1819S1-T13-1/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/chenlu-chua/main/branch/master[image:https://ci.appveyor.com/api/projects/status/2xd9spc31800oyf9/branch/master?svg=true[Build status]]
+https://coveralls.io/github/CS2103-AY1819S1-T13-1/main?branch=master[image:https://coveralls.io/repos/github/CS2103-AY1819S1-T13-1/main/badge.svg?branch=master[Coverage Status]]
+image:https://api.codacy.com/project/badge/Grade/d3e0052076014d05b17685f5d61307bf["Codacy code quality", link="https://www.codacy.com/app/hrxiong/TutorPal-T13-1?utm_source=github.com&utm_medium=referral&utm_content=CS2103-AY1819S1-T13-1/main&utm_campaign=Badge_Grade"]
 https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
 
 ifdef::env-github[]
@@ -15,26 +15,25 @@ 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.
+* This is a desktop TutorPal application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
+* It is an application intended to help private tutors to manage their students information.
+* It has features specifically catered to tutors' needs:
+** Users can store student information such as name, address, contact number, education level, tuition timing and fees of a student.
+** Users are able to assign grades to students based on their examination result.
+** Users are able to calculate their tuition earnings.
+** Users can review the effectiveness of their teaching methods through a analysis of students' grades over time.
 
 == 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_.
+* The original source of code: AddressBook-Level4 project created by SE-EDU initiative at https://github.com/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]
+* Done by team CS2103-AY1819S1-T13-1
 
 == Licence : link:LICENSE[MIT]

_reposense/config.json

@@ -0,0 +1,30 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "CJuanvip",
+      "displayName": "CHE...UAN",
+      "authorNames": ["CJuanvip", "cj"]
+    },
+    {
+      "githubId": "chenlu-chua",
+      "displayName": "CHUA ...EN LU",
+      "authorNames": ["chenlu-chua", "chenlu"]
+    },
+    {
+      "githubId": "LZYAndy",
+      "displayName": "LIU Z...HAOYU",
+      "authorNames": ["LZYAndy", "刘照宇"]
+    },
+    {
+      "githubId": "junjiee",
+      "displayName": "ONG J...N JIE",
+      "authorNames": ["junjiee", "Ong Jun Jie"]
+    },
+    {
+      "githubId": "hrxiong",
+      "displayName": "XIONG...AORAN",
+      "authorNames": ["hrxiong"]
+    }
+  ]
+}

build.gradle

@@ -207,9 +207,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-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
+        'site-name': 'TutorPal',
+        'site-githuburl': 'https://github.com/CS2103-AY1819S1-T13-1/main',
     ]
 
     options['template_dirs'].each {

docs/AboutUs.adoc

@@ -4,53 +4,57 @@
 :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} +
+TutorPal was developed by the CS2103-AY1819S1-T13-1 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>>]
+=== Chua Chenlu
+image::chenlu-chua.png[width="150", align="left"]
+{empty}[https://github.com/chenlu-chua[github]] [<<chenlu-chua#, portfolio>>]
 
-Role: Project Advisor
+Role: Team lead + Testing
+
+Responsibilities: UI
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Chen Juan
+image::cjuanvip.png[width="150", align="left"]
+{empty}[http://github.com/CJuanvip[github]] [<<cjuanvip#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Deliverables and deadline + Scheduling and tracking
+
+Responsibilities: Logic
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Liu Zhaoyu
+image::lzyandy.png[width="150", align="left"]
+{empty}[http://github.com/LZYAndy[github]] [<<lzyandy#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Documentation + Code quality
+
+Responsibilities: Model
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Ong Junjie
+image::junjiee.png[width="150", align="left"]
+{empty}[http://github.com/junjiee[github]] [<<junjiee#, portfolio>>]
+
+Role: Code quality
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Storage
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Xiong Haoran
+image::hrxiong.png[width="150", align="left"]
+{empty}[http://github.com/hrxiong[github]] [<<hrxiong#, portfolio>>]
+
+Role: Testing + Integration
 
-Role: Developer +
 Responsibilities: UI
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,4 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/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`
+* *Bug reports, Suggestions* : Post in our https://github.com/CS2103-AY1819S1-T13-1/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.