[CS2113-W11-2] WildWatch

.github/workflows/gradle.yml

@@ -13,11 +13,6 @@ jobs:
       - name: Set up repository
         uses: actions/checkout@master
 
-      - name: Set up repository
-        uses: actions/checkout@master
-        with:
-          ref: master
-
       - name: Merge to master
         run: git checkout --progress --force ${{ github.sha }}
 
@@ -30,6 +25,16 @@ jobs:
           java-version: '11'
           java-package: jdk+fx
 
+      # Install dos2unix on Linux
+      - name: Install dos2unix (Linux)
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y dos2unix
+
+      # Install dos2unix on macOS
+      - name: Install dos2unix (macOS)
+        if: runner.os == 'macOS'
+        run: brew install dos2unix
+
       - name: Build and check with Gradle
         run: ./gradlew check
 
@@ -47,4 +52,4 @@ jobs:
         if: always() && runner.os == 'Windows'
         working-directory:  ${{ github.workspace }}/text-ui-test
         shell: cmd
-        run: runtest.bat
+        run: runtest.bat

.gitignore

@@ -13,5 +13,14 @@ src/main/resources/docs/
 *.iml
 bin/
 
-/text-ui-test/ACTUAL.TXT
+
+text-ui-test/runtest.bat
+text-ui-test/runtest.sh
+WildWatch.log
+text-ui-test/ACTUAL.TXT
+META-INF/MANIFEST.MF
 text-ui-test/EXPECTED-UNIX.TXT
+WildWatch.log.1
+WildWatch.log.1.lck
+WildWatch.log.lck
+WildWatch.txt

README.md

@@ -1,5 +1,6 @@
 # Duke project template
 
+
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 
 ## Setting up in Intellij
@@ -8,20 +9,14 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 
 1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project.
 1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/wildwatch/WildWatch.java` file, right-click it, and choose `Run WildWatch.main()`. If the setup is correct, you should see something like the below:
    ```
    > Task :compileJava
    > Task :processResources NO-SOURCE
    > Task :classes
-
    > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
+   Hello there! Welcome to Wild Watch!
+
    What is your name?
    ```
    Type some word and press enter to let the execution proceed to the end.

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.wildwatch.WildWatch")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("wildwatch")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,8 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+| Display                                                                                 |    Name     |              Github Profile              |              Portfolio               |
+|-----------------------------------------------------------------------------------------|:-----------:|:----------------------------------------:|:------------------------------------:|
+| ![](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/252865bb-811e-48b1-9777-6c01b98500b1) | Lee Sungmin | [Github](https://github.com/woodenclock) | [Portfolio](https://github.com/AY2324S1-CS2113T-W11-2/tp/blob/master/docs/team/leesungmin.md#lee-sungmin) |
+| ![](https://via.placeholder.com/100.png?text=Photo)                                     |   Don Joe   |      [Github](https://github.com/)       |  [Portfolio](docs/team/johndoe.md)   |
+| ![](https://via.placeholder.com/100.png?text=Photo)                                     |  Ron John   |      [Github](https://github.com/)       |  [Portfolio](docs/team/johndoe.md)   |
+| ![](https://via.placeholder.com/100.png?text=Photo)                                     |  John Roe   |      [Github](https://github.com/)       |  [Portfolio](docs/team/johndoe.md)   |

docs/DeveloperGuide.md

@@ -1,38 +1,71 @@
 # Developer Guide
 
+- [Acknowledgements](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#acknowledgements)
+- [Design & Implementation](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#design--implementation)
+- [Product Scope](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#product-scope)
+  - [Target User Profile](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#target-user-profile)
+  - [Value Proposition](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#value-proposition)
+- [User Story](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#user-stories)
+- [Non-Funtional Requirements](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#non-functional-requirements)
+- [Glossary](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#glossary)
+- [Manual Testing](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#manual-testing)
+- [Command Summary](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#command-summary)
+
 ## Acknowledgements
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+Some code snippets were referenced from [here](https://github.com/woodenclock/ip.git).
 
-## Design & implementation
+
+
+## Design & Implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+WildWatch is a CLI based software that helps zoos keep track of animal inhabitants.
+
+
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+Target user profile are the clerks working in zoos.
+
 
 ### Value proposition
 
 {Describe the value proposition: what problem does it solve?}
 
+
 ## User Stories
 
 |Version| As a ... | I want to ... | So that I can ...|
 |--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
+|v1.0|new user|see help instructions|refer to them when I forget how to use the application|
+|v1.0|zoo clerk|add an animal entry|record the animals in the zoo, and refer to them afterwards|
+|v1.0|zoo clerk|delete an animal entry|remove redundant or invalid animal entry|
+|v1.0|zoo clerk|list all the entries|see what entries I have entered previously, and refer to them|
 |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
 
+
+
 ## Non-Functional Requirements
 
 {Give non-functional requirements}
 
+
+
 ## Glossary
 
 * *glossary item* - Definition
 
-## Instructions for manual testing
+
+
+## Manual Testing
 
 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+
+
+
+## Command Summary
+
+

docs/README.md

@@ -1,6 +1,6 @@
-# Duke
+# WildWatch
 
-{Give product intro here}
+Wildwatch is a program for recording down individual wildlife in a wildlife reserve via a Command Line Interface (CLI).
 
 Useful links:
 * [User Guide](UserGuide.md)