[CS2103T-T12-2] Swift+

.gitignore

@@ -8,11 +8,15 @@ src/main/resources/docs/
 /out/
 /*.iml
 
+# VSCode files
+/.vscode/
+
 # Storage/log files
 /data/
 /config.json
 /preferences.json
 /*.log.*
+/bin/
 
 # Test sandbox files
 src/test/data/sandbox/

README.md

@@ -1,14 +1,31 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# Swift+
+
+[![codecov](https://codecov.io/gh/AY2223S1-CS2103T-T12-2/tp/branch/master/graph/badge.svg?token=A2FU6P932B)](https://app.codecov.io/gh/AY2223S1-CS2103T-T12-2/tp)
+[![CI Status](https://github.com/AY2223S1-CS2103T-T12-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S1-CS2103T-T12-2/tp/actions)
 
 ![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.
+### Manage your Team like never before
+
+#### Team: Swift+ (CS2103-T12-02)
+
+- Swift+ is a seamless contact management system to keep track of their interactions and meetings with clients and colleagues using swift text-based commands.
+- Swift+ allows you to plan your schedules looking at their daily/weekly overview.
+
+## Getting Started
+
+1. Download and install `jenv`
+2. Install `Java 11`
+3. Clone the project
+
+## Site Map
+
+- [User Guide](docs/UserGuide.md)
+- [Developer Guide](docs/DeveloperGuide.md)
+- [About Us](docs/AboutUs.md)
+
+## Acknowledgements
+
+- This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+- Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+- UI color scheme inspired by [TailwindUI](https://tailwindui.com/)

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'swift.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -25,6 +25,10 @@ test {
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'swift+.jar'
 }
 
 defaultTasks 'clean', 'test'

codecov.yml

@@ -0,0 +1,10 @@
+coverage:
+  status:
+    patch:
+      default:
+        target: 0%
+        threshold: 50%
+    project:
+      default:
+        target: auto
+        threshold: 75%

docs/AboutUs.md

@@ -5,55 +5,55 @@ 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 `jason.qiu@u.nus.edu`
 
-## Project team
+## **Project team**
 
-### John Doe
+### Jason Qiu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jasonqiu212.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jasonqiu212)]
+[[portfolio](team/jasonqiu212.md)]
 
-* Role: Project Advisor
+- Role: Team lead
+- Responsibilities: UI
 
-### Jane Doe
+### Pontakorn Prasertsuk
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/peppapighs.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/peppapighs)]
+[[portfolio](team/peppapighs.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+- Role: Code Quality
+- Responsibilities: UI
 
-### Johnny Doe
+### Shenyi Cui
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/shenyicui.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/shenyicui)] [[portfolio](team/shenyicui.md)]
 
-* Role: Developer
-* Responsibilities: Data
+- Role: Deliverables
+- Responsibilities: Issues
 
-### Jean Doe
+### Muthukrishnan Santosh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/santosh3007.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/santosh3007)]
+[[portfolio](team/santosh3007.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+- Role: Documentation
+- Responsibilities: Manage Non-Functional Requirements
 
-### James Doe
+### Chin Yun Ru
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/yunruu.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/yunruu)]
+[[portfolio](team/yunruu.md)]
 
-* Role: Developer
-* Responsibilities: UI
+- Role: Integration
+- Responsibilities: Glossary

docs/Configuration.md

@@ -1,6 +1,6 @@
 ---
 layout: page
-title: Configuration guide
+title: Configuration Guide
 ---
 
-Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
+Certain properties of the application can be controlled (e.g. user preferences file location, logging level) through the configuration file (default: `config.json`).

docs/DevOps.md

@@ -1,53 +1,54 @@
 ---
 layout: page
-title: DevOps guide
+title: DevOps Guide
 ---
 
-* Table of Contents
-{:toc}
+## Table of Contents
+{:.no_toc}
 
---------------------------------------------------------------------------------------------------------------------
+1. Table of Contents
+{:toc}
 
-## 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)**.
+## **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).<br>
   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 creat a fat JAR file in the `build/lib` folder, _if the current file is outdated_.<br>
   e.g. `./gradlew shadowJar`.
 
-* **`run`**: Builds and runs the application.<br>
+- **`run`**: Builds and runs the application.<br>
   **`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.<br>
   **`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 (CI)**
 
 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.
 
-### Code coverage
+### Code Coverage
 
 As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your testes. Here are the steps to set up CodeCov for a fork of this repository.
 
 1. Sign up with Codecov using your GitHub account [here](https://codecov.io/signup).
-1. Once you are inside Codecov web app, add your org (that contains the fork) to CodeCov.
-1. Wait for the next run of CI in your fork (or push a dummy commit to it to trigger CI) to confirm CI is able to upload generated coverage data to CodeCov. If CodeCov is not set up correctly, the CI run will fail with an error message that mentions CodeCov.
-1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.
+2. Once you are inside Codecov web app, add your org (that contains the fork) to CodeCov.
+3. Wait for the next run of CI in your fork (or push a dummy commit to it to trigger CI) to confirm CI is able to upload generated coverage data to CodeCov. If CodeCov is not set up correctly, the CI run will fail with an error message that mentions CodeCov.
+4. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/AY2223S1-CS2103T-T12-2/tp/branch/master/graph/badge.svg?token=A2FU6P932B)](https://app.codecov.io/gh/AY2223S1-CS2103T-T12-2/tp) in that page reflects the coverage of your project.
 
-### Repository-wide checks
+### Repository-wide Checks
 
 In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.
 
@@ -59,22 +60,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
+## **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. 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.
+1. Update the version number in [`MainApp.java`](https://github.com/AY2223S1-CS2103T-T12-2/tp/blob/master/src/main/java/swift/MainApp.java).
+2. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
+3. Tag the repo with the version number. e.g. `v0.1`
+4. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.