[CS2103-F10-2] Le Tracker

.github/ISSUE_TEMPLATE/documentation-bug-report.md

@@ -0,0 +1,15 @@
+---
+name: Documentation Bug report
+about: A template for documentation bugs
+title: ''
+labels: type.Bug
+assignees: ''
+
+---
+
+### Documentation of Interest
+User guide / Documentation guide / ...
+
+### Section Affected
+
+### Description

.github/ISSUE_TEMPLATE/functional-bug-report.md

@@ -0,0 +1,20 @@
+---
+name: Functional Bug report
+about: A template for functionality bugs
+title: ''
+labels: type.Bug
+assignees: ''
+
+---
+
+### Description
+
+### Steps for reproducing
+
+### Expected output
+
+### Actual output
+
+### Other details
+
+### Error output

.gitignore

@@ -3,8 +3,13 @@
 /build/
 src/main/resources/docs/
 
+# VSCode files
+/.vscode/
+/bin/
+
 # IDEA files
 /.idea/
+*/.idea/
 /out/
 /*.iml
 

README.md

@@ -1,14 +1,12 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2223S2-CS2103-F10-2/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2223S2-CS2103-F10-2/tp/actions/workflows/gradle.yml)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+Welcome to the Le Tracker project!
+* Our goal is to help create a stress-free learning environment for all students!<br>
+* Le Tracker enables students to **easily log their lecture progress**. <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.
+  * add-module /code CS2040 /name Data Structures & Algorithms
+  * mark /module CS2040 /lecture 1 /video lecture_01-part-1
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -63,10 +63,15 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+    testImplementation('org.junit.platform:junit-platform-launcher:1.5.2')
+}
+
+run {
+    enableAssertions = true
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'letracker.jar'
 }
 
 defaultTasks 'clean', 'test'

config/checkstyle/checkstyle.xml

@@ -344,6 +344,7 @@
     <module name="Indentation">
       <property name="caseIndent" value="0" />
       <property name="throwsIndent" value="8" />
+      <property name="lineWrappingIndentation" value="8"/>
     </module>
 
     <module name="NoWhitespaceBefore">

copyright.txt

@@ -1,8 +1,7 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
-Copyright by Susumu Yoshida - http://www.mcdodesign.com/
-- address_book_32.png
-- AddressApp.ico
+Copyright by Juicy Fish - https://www.flaticon.com/authors/juicy-fish
+- time_tracker.png
 
 Copyright by Jan Jan Kovařík - http://glyphicons.com/
 - calendar.png

docs/AboutUs.md

@@ -5,55 +5,57 @@ 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 `ay2223s2-cs2103-f10-2.zhzgv@aleeas.com`
 
 ## Project team
 
-### John Doe
+### Lee Shao Wee
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/shaowi.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[homepage](https://leeshaowee.netlify.app/)]
+[[github](https://github.com/shaowi)]
+[[portfolio](team/shaowi.md)]
 
-* Role: Project Advisor
+- Role: Developer
+- Responsibilities: Deliverables, deadlines, scheduling and tracking
 
-### Jane Doe
+### Hing Zi Yang Benedict
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hingen.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/hingen)]
+[[portfolio](team/hingen.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+- Role: Developer
+- Responsibilities: Code Quality + Integration
 
-### Johnny Doe
+### Khang Tran
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lennoxtr.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/lennoxtr)]
+[[portfolio](team/lennoxtr.md)]
 
-* Role: Developer
-* Responsibilities: Data
+- Role: Developer
+- Responsibilities: File I/O
 
-### Jean Doe
+### Joy Tan QiaoTong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/joytqt-1202.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/joytqt-1202)]
+[[portfolio](team/joytqt-1202.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+- Role: Developer
+- Responsibilities: Documentation + Testing
 
-### James Doe
+### Jedidiah Cheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jedidiahc.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jedidiahC)]
+[[portfolio](team/jedidiahc.md)]
 
-* Role: Developer
-* Responsibilities: UI
+- Role: Developer
+- Responsibilities: UI

docs/DevOps.md

@@ -3,38 +3,41 @@ layout: page
 title: DevOps guide
 ---
 
-* Table of Contents
-{:toc}
+## Table of Contents
 
---------------------------------------------------------------------------------------------------------------------
+- [Build automation](#build-automation)
+- [Continuous Integration](#continuous-integration)
+  - [Code coverage](#code-coverage)
+  - [Repository-wide checks](#repository-wide-checks)
+- [Making a release](#making-a-release)
+
+---
 
 ## Build automation
 
 This project uses Gradle for **build automation and dependency management**. **You are recommended to read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.
 
-
 Given below are how to use Gradle for some important project tasks.
 
-
-* **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).<br>
+- **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).\
   e.g. `./gradlew clean`
 
-* **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, *if the current file is outdated*.<br>
+- **`shadowJar`**: Uses the ShadowJar plugin to create a fat JAR file in the `build/lib` folder, _if the current file is outdated_.\
   e.g. `./gradlew shadowJar`.
 
-* **`run`**: Builds and runs the application.<br>
+- **`run`**: Builds and runs the application.\
   **`runShadow`**: Builds the application as a fat JAR, and then runs it.
 
-* **`checkstyleMain`**: Runs the code style check for the main code base.<br>
+- **`checkstyleMain`**: Runs the code style check for the main code base.\
   **`checkstyleTest`**: Runs the code style check for the test code base.
 
-* **`test`**: Runs all tests.
-  * `./gradlew test` — Runs all tests
-  * `./gradlew clean test` — Cleans the project and runs tests
+- **`test`**: Runs all tests.
+  - `./gradlew test` — Runs all tests
+  - `./gradlew clean test` — Cleans the project and runs tests
 
---------------------------------------------------------------------------------------------------------------------
+---
 
-## Continuous integration (CI)
+## Continuous Integration
 
 This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the `.github/workflows` folder). No further setting up required.
 
@@ -58,22 +61,23 @@ Any warnings or errors will be printed out to the console.
 
 **If adding new checks:**
 
-* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.
+- Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.
+
+- Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE`
 
-* Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE`
-  * SEVERITY is either ERROR or WARN.
-  * FILENAME is the path to the file relative to the current directory.
-  * LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
+  - SEVERITY is either ERROR or WARN.
+  - FILENAME is the path to the file relative to the current directory.
+  - LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
 
-* Check scripts must exit with a non-zero exit code if any errors occur.
+- Check scripts must exit with a non-zero exit code if any errors occur.
 
---------------------------------------------------------------------------------------------------------------------
+---
 
 ## Making a release
 
 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/AY2223S2-CS2103-F10-2/tp/tree/master/src/main/java/seedu/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.