[CS2103T-T08-2] OnlySales

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.gitignore

@@ -2,6 +2,7 @@
 /.gradle/
 /build/
 src/main/resources/docs/
+bin/
 
 # IDEA files
 /.idea/
@@ -21,3 +22,5 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+.vscode/

README.md

@@ -1,14 +1,26 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/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/#contributing-to-se-edu) for more info.
+[![CI Status](https://github.com/AY2526S1-CS2103T-T08-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2526S1-CS2103T-T08-2/tp/workflows/Java%20CI/badge.svg)
+[![codecov](https://codecov.io/gh/AY2526S1-CS2103T-T08-2/tp/graph/badge.svg?token=9LRCCBVF2H)](https://codecov.io/gh/AY2526S1-CS2103T-T08-2/tp)
+
+# OnlySales
+
+> The typing-first product for salesperson to unlock their full potential in managing their customers' contact information
+
+## Features
+
+### Minimal Viable Product
+
+* **Add Customer** - Add new customer contact information
+* **Edit Customer** - Edit existing customer information
+* **Delete Customer** - Delete the customer from the app
+* **List Customer** - View all customers
+* **Set Status** - Update customer contact status (eg. uncontacted, rejected, etc.)
+* **Find Customer** - Search by tag, status, or name
+* **Create Email Template** - Generate email templates to copy for communication
+
+## Documentation
+
+View the documentation [here](https://ay2526s1-cs2103t-t08-2.github.io/tp/)
+
+## Support
+
+File a bug report [here](https://github.com/AY2526S1-CS2103T-T08-2/tp/issues/new?template=bug_report.md)

build.gradle

@@ -18,13 +18,18 @@ repositories {
 
 checkstyle {
     toolVersion = '11.0.0'
+    configFile = file('config/checkstyle/checkstyle.xml')
 }
 
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -43,6 +48,7 @@ task coverage(type: JacocoReport) {
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '17.0.7'
+    String testFxVersion = '4.0.18'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
@@ -63,10 +69,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 group: 'org.testfx', name: 'testfx-core', version: testFxVersion
+    testImplementation group: 'org.testfx', name: 'testfx-junit5', version: testFxVersion
+    testImplementation  'org.testfx:openjfx-monocle:17.0.10'
+    testImplementation group: 'org.hamcrest', name: 'hamcrest', version: '2.2'
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'OnlySales.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,40 @@ 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`
-
 ## Project team
 
-### John Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Project Advisor
-
-### Jane Doe
+### Nihaal Manaf
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nihaalmanaf.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/nihaalmanaf)] [[portfolio](team/nihaalmanaf.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+- Role: Team Lead
+- Responsibilities: DevOps + Leading
 
-### Johnny Doe
+### Poh Anson
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/pohanson.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/pohanson)]
 
-* Role: Developer
-* Responsibilities: Data
+- Role: Developer
+- Responsibilities: Storage
 
-### Jean Doe
+### Sean Richardson Hardjanto
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/seanrh34.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/seanrh34)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+- Role: Developer
+- Responsibilities: UI, Logic, and Model
 
-### James Doe
+### Zhao Ruixuan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/rotarykirby.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/rotarykirby)]
 
-* Role: Developer
-* Responsibilities: UI
+- Role: Developer
+- Responsibilities: UI, Logic, and Model