[CS2103T-W12-4] TAssist

.gitignore

@@ -10,6 +10,7 @@ src/main/resources/docs/
 
 # Storage/log files
 /data/
+/bin/
 /config.json
 /preferences.json
 /*.log.*

README.md

@@ -1,14 +1,67 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![codecov](https://codecov.io/github/AY2425S2-CS2103T-W12-4/tp/graph/badge.svg?token=M00EE5N8JL)](https://codecov.io/github/AY2425S2-CS2103T-W12-4/tp)
+
+[![Java CI](https://github.com/AY2425S2-CS2103T-W12-4/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2425S2-CS2103T-W12-4/tp/actions/workflows/gradle.yml)
 
 ![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.
+## **🤖 TAssist **
+A Teaching Assistant Management Tool
+
+## **Overview** 💡
+TAssist is a desktop application designed for university tutors and teaching assistants (TAs) to efficiently
+manage students, track progress, and assign students to project teams or classes.
+
+The application is built for users who prefer keyboard-driven interactions, ensuring fast and efficient student
+management.
+
+TAssist is built with a Command Line Interface (CLI) and Graphical User Interface (GUI) to enhance productivity
+while maintaining usability.
+
+## **Key Features**
+
+### **🤓 Student Management**
+- **View a list of students** – Quickly browse all students.
+- **Add, edit, or delete student details** – Manage contact details easily.
+- **Store multiple GitHub repositories per student** – Store github accounts and repositories for each student.
+
+### **🖊️ Progress Tracking**
+- **Assign progress levels to students** – Track learning outcomes.
+- **Set assignment deadlines and reminders** – Keep students on track.
+- **Filter students by progress** – Identify those who need help.
+
+### **📁 Class & Team Organization**
+- **Assign students to project teams and classes** – Keep groups structured.
+- **Bulk edit project team assignments** – Reorganize teams quickly.
+- **Export student to a CSV file** – Share with other TAs.
+- **Import student from a CSV file** - Add multiple students at once.
+
+### **🔔 Task & Reminder System**
+- **Set and view reminders for student tasks** – Never miss follow-ups.
+- **Schedule notifications for assignment deadlines** – Keep students accountable.
+- **Take notes for individual students** – Keep track of personal progress.
+
+### **⚡ Keyboard-Optimized Workflow**
+- **Switch between semester views** – View previous students without cluttering the current list.
+- **Perform actions via keyboard shortcuts** – Work faster without a mouse.
+
+## 📚 Documentation
+
+📖 [User Guide](docs/UserGuide.md) | 🛠 [Developer Guide](docs/DeveloperGuide.md)
+
+## **Installation & Setup**
+
+### **System Requirements**
+- **Java 17 or later**
+- Windows, macOS, or Linux
+
+### **Installation Steps**
+1. **Download** the latest `TAssist.jar` from the **[Releases](https://github.com/AY2425S2-CS2103T-W12-4/tp/releases)** page.
+2. **Open a terminal** and navigate to the folder where `TAssist.jar` is located.
+3. **Run the application** with:
+   ```
+    java -jar TAssist.jar
+   ```
+
+## **Acknowledgment**
+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 = 'tassist.address.Main'
 
 sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
@@ -59,14 +59,20 @@ dependencies {
 
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
+    implementation group: 'com.opencsv', name: 'opencsv', version: '5.6'
+
+    testImplementation 'junit:junit:4.13.2'  // Optional: JUnit for testing if you need it
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'TAssist-1.5.jar'
+}
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -9,51 +9,51 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Kenji Leong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/kkenjji.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/kkenjji)]
+[[portfolio](team/kkenjji.md)]
 
-* Role: Project Advisor
+* Role: Developer
 
-### Jane Doe
+### Harbour Wang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nano-233.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Nano-233)]
+[[portfolio](team/harbour.md)]
 
 * Role: Team Lead
 * Responsibilities: UI
 
-### Johnny Doe
+### Casie Lim
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/casielim.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/Casielim)]
+[[portfolio](team/casielim.md)]
 
 * Role: Developer
 * Responsibilities: Data
 
-### Jean Doe
+### Eliza Cajetas
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/elizazaa.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/elizazaa)]
+[[portfolio](team/eliza.md)]
 
 * Role: Developer
 * Responsibilities: Dev Ops + Threading
 
-### James Doe
+### Sulaksha Muthukrishnan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/crmlatte.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/crmlatte)]
+[[portfolio](team/crmlatte.md)]
 
 * Role: Developer
 * Responsibilities: UI

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/se-edu/addressbook-level3/tree/master/src/main/java/tassist/address/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.