[CS2103T-W10-4] StoreClass

.github/workflows/gradletest.yml

@@ -0,0 +1,46 @@
+name: Java CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@main
+
+      - name: Set up repository
+        uses: actions/checkout@main
+        with:
+          ref: master
+
+      - name: Merge to master
+        run: git checkout --progress --force ${{ github.sha }}
+
+      - name: Run repository-wide tests
+        if: runner.os == 'Linux'
+        working-directory:  ${{ github.workspace }}/.github
+        run: ./run-checks.sh
+
+      - name: Validate Gradle Wrapper
+        uses: gradle/actions/wrapper-validation@v3
+
+      - name: Setup JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: '17'
+          java-package: jdk+fx
+
+      - name: Build and check with Gradle
+        run: ./gradlew check coverage
+
+      - name: Upload coverage reports to Codecov
+        if: runner.os == 'Linux'
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -21,3 +21,4 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+archived

README.md

@@ -1,14 +1,17 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![Java CI](https://github.com/AY2425S1-CS2103T-W10-4/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2425S1-CS2103T-W10-4/tp/actions/workflows/gradle.yml)[![codecov](https://codecov.io/gh/AY2425S1-CS2103T-W10-4/tp/graph/badge.svg?token=ISBALRKKO7)](https://codecov.io/gh/AY2425S1-CS2103T-W10-4/tp)
+
+# StoreClass
+**StoreClass** is a project done by Software Engineering (SE) students. <br>
 
 ![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.
+## What is StoreClass?
+* StoreClass is designed to be used by educators in private educational institutions such as tuition centers, allowing educators to quickly
+access student information such as contact details, class details and other necessary information.
+* It is optimized for users who are comfortable using the command-line interface (CLI), which allows for faster inputs through text-based inputs.
+
+## Project Information
   * 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.
+* It is named `StoreClass` as it is a play on words, stating how the class of students are stored.
+* For the detailed documentation of this project, see the **[StoreClass Documentation](https://ay2425s1-cs2103t-w10-4.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -70,3 +70,7 @@ shadowJar {
 }
 
 defaultTasks 'clean', 'test'
+
+run {
+    enableAssertions = true
+}

docs/AboutUs.md

@@ -9,51 +9,61 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Prabhu NATARAJAN
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/prabhu.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
+[[homepage](https://www.comp.nus.edu.sg/cs/people/prabhu/)]
+[[github](https://github.com/prabhu-na)]
 [[portfolio](team/johndoe.md)]
 
 * Role: Project Advisor
 
-### Jane Doe
+### Tan Yong Quan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/yongqqqq.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/yongqqqq)]
 [[portfolio](team/johndoe.md)]
 
 * Role: Team Lead
 * Responsibilities: UI
 
-### Johnny Doe
+### Isaac Lim Tzee Zac
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/isaactodo.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/isaactodo)] [[portfolio](team/johndoe.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Documentation, Code Quality, Deliverables and Deadlines
+* Responsibilities: Integration
 
-### Jean Doe
+### Lei Jianwen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jianwen0451.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/jianwen0451)]
 [[portfolio](team/johndoe.md)]
 
-* Role: Developer
+* Role: Developer Java Expert
 * Responsibilities: Dev Ops + Threading
 
-### James Doe
+### Collin Tan Yu Qi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tanyqcollin.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/tanyqcollin)]
 [[portfolio](team/johndoe.md)]
 
 * Role: Developer
 * Responsibilities: UI
+
+### Tee Jing Hong
+
+<img src="images/radieonajax.png" width="200px">
+
+[[github](http://github.com/RadieonAjax)]
+[[portfolio](team/RadieonAjax.md)]
+
+* Role: Developer
+* Responsibilities: UI