[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,15 @@ 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
+WildWatch Entry Collection.txt

README.md

@@ -1,64 +1,13 @@
-# 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
-
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
-
-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:
-   ```
-   > Task :compileJava
-   > Task :processResources NO-SOURCE
-   > Task :classes
-
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
-   ```
-   Type some word and press enter to let the execution proceed to the end.
-
-## Build automation using Gradle
-
-* This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the `build.gradle` file).
-* If you are new to Gradle, refer to the [Gradle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/gradle.html).
-
-## Testing
-
-### I/O redirection tests
-
-* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script.
-
-### JUnit tests
-
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
-* If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
-
-## Checkstyle
-
-* A sample CheckStyle rule configuration is provided in this project.
-* If you are new to Checkstyle, refer to the [Checkstyle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/checkstyle.html).
-
-## CI using GitHub Actions
-
-The project uses [GitHub actions](https://github.com/features/actions) for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR.
-
-## Documentation
-
-`/docs` folder contains a skeleton version of the project documentation.
-
-Steps for publishing documentation to the public: 
-1. If you are using this project template for an individual project, go your fork on GitHub.<br>
-   If you are using this project template for a team project, go to the team fork on GitHub.
-1. Click on the `settings` tab.
-1. Scroll down to the `GitHub Pages` section.
-1. Set the `source` as `master branch /docs folder`.
-1. Optionally, use the `choose a theme` button to choose a theme for your documentation.
+# WildWatch
+
+![image](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/6c982946-3165-41ec-917a-54c46c30b012)
+
+Welcome aboard fellow animal lover! We are really excited to have you here! 😉  
+Wildwatch is a program for a clerk managing wildlife data in a wildlife reserve via the Command Line Interface (CLI).  
+The purpose of this user guide is to familiarize you with the program and help you when you face a problem using it.  
+Its main job is to store and present animal data, this would make your job so much more convenient!  
+
+Useful links:
+* [About Us](https://ay2324s1-cs2113t-w11-2.github.io/tp/AboutUs.html)
+* [User Guide](https://ay2324s1-cs2113t-w11-2.github.io/tp/UserGuide.html)
+* [Developer Guide](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html)

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) |Tang Zhen En | [Github](https://github.com/tangzhenen)  |  [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)   |