[CS2103T-W08-2] Source Control

.gitignore

@@ -13,6 +13,7 @@ src/main/resources/docs/
 /config.json
 /preferences.json
 /*.log.*
+/*sourceControl*.csv
 
 # Test sandbox files
 src/test/data/sandbox/

README.md

@@ -1,14 +1,30 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# Source Control
+
+[![CI Status](https://github.com/AY2122S1-CS2103T-W08-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S1-CS2103T-W08-2/tp/actions)
+
+**Source Control** is a desktop app for CS1101S professors to manage the performance of their students.
+
+This application allows you to **store comprehensive data** of each student quickly, and allows you to search through them easily. With Source Control, you will never have to worry about your large student cohort and tracking numerous assessments!
+
+Source Control can also give you both a quick overview and a closer look of how your students are performing. This application **provides in-depth data analysis** of the performance of your students in each assessment, giving you timely feedback on the pace and difficulty level of the module.
+
+Source Control is **optimized for use via a Command Line Interface (CLI)** while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Source Control can help you track your students’ performance faster than traditional GUI apps!
 
 ![Ui](docs/images/Ui.png)
 
-* 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.
-  * 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.
+## Usage
+* Keeps track of administrative info and academic records of large student intake.
+* Analyzes the performance of individual, groups and the cohort in assessments.
+
+## User Guide
+If you are interested in using **Source Control**, head over to the [Quick Start section of the **User Guide**](https://ay2122s1-cs2103t-w08-2.github.io/tp/UserGuide.html#quick-start).
+
+## Developer Guide
+If you are interested in developing **Source Control**, check out the **[Developer Guide](https://ay2122s1-cs2103t-w08-2.github.io/tp/DeveloperGuide.html)** for information on how the application is designed.
+
+## About Us
+If you are interested in contacting **Source Control** team, visit the [**About Us** website](https://ay2122s1-cs2103t-w08-2.github.io/tp/AboutUs.html).
+
+## Acknowledgements
+* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+* Original project: [AddressBook Level-3](https://se-education.org/addressbook-level3) project created as part of the [SE-EDU](https://se-education.org) initiative

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.sourcecontrol.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -16,6 +16,10 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true
+}
+
 checkstyle {
     toolVersion = '8.29'
 }
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'sourceControl.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,54 @@ 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 `e0544170@u.nus.edu`
 
 ## Project team
 
-### John Doe
+### Jonas Chow
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jonas-chow.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jonas-chow)]
+[[portfolio](team/jonas-chow.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: Testing + Scheduling and tracking
 
-### Jane Doe
+### Tang Zhiying
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zhing22.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/zhing22)]
+[[portfolio](team/zhing22.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Documentation + Code quality
 
-### Johnny Doe
+### Gan Hong Yao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ganhongyao.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/ganhongyao)] [[portfolio](team/ganhongyao.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Testing + Integration
 
-### Jean Doe
+### Nguyen Ba Van Nhi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nbvannhi.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/nbvannhi)] [[portfolio](team/nbvannhi.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Documentation + Code quality
 
-### James Doe
+### Leong Hong Fai
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/leonghongfai.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/leonghongfai)]
+[[portfolio](team/leonghongfai.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Integration + Deliverables and Deadlines