[CS2103T-T17-3] Tutorly

README.md

@@ -1,14 +1,19 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+<div align="center">
+
+# Tutorly
+
+![Java CI](https://img.shields.io/github/actions/workflow/status/AY2425S2-CS2103T-T17-3/tp/gradle.yml?style=for-the-badge&label=Java%20CI)
+![Codecov](https://img.shields.io/codecov/c/gh/AY2425S2-CS2103T-T17-3/tp?style=for-the-badge)
+
+</div>
 
 ![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/#contributing-to-se-edu) for more info.
+## About
+
+Tutorly is a desktop application designed specifically for private tutors. It empowers tutors to quickly track student records, log lesson details, record attendance, and generate progress reports - all through fast, keyboard-driven interactions.
+
+For more information, please refer to our [Product Website](https://ay2425s2-cs2103t-t17-3.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 = 'tutorly.Main'
 
 sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
@@ -66,7 +66,12 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'tutorly.jar'
+}
+
+run {
+    standardInput = System.in
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

copyright.txt

@@ -4,6 +4,9 @@ Copyright by Susumu Yoshida - http://www.mcdodesign.com/
 - address_book_32.png
 - AddressApp.ico
 
-Copyright by Jan Jan Kovařík - http://glyphicons.com/
+Copyright by Emojipedia - https://emojipedia.org/
 - calendar.png
-- edit.png
+- email.png
+- house.png
+- memo.png
+- telephone.png

docs/AboutUs.md

@@ -5,55 +5,52 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](https://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 `tutorly[at]groups.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Nickie Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nickt121.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/nickt121)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Documentation, Testing
 
-### Jane Doe
+### Roy Tay
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/themintchoco.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/themintchoco)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: Git expert, Integration
 
-### Johnny Doe
+### Chen Jiahao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/neilchen863.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/Neilchen863)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: developer
+* Responsibilities: Testing, Documentation
 
-### Jean Doe
+### Lam Yu Han Bryan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sociallyineptweeb.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/sociallyineptweeb)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Deliverables and deadlines, Scheduling and tracking
 
-### James Doe
+### Lee Zhan Hong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zhannyhong.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Zhannyhong)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: IntelliJ expert, Code quality
+

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/AY2425S2-CS2103T-T17-3/tp/tree/master/src/main/java/tutorly/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
 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.