Fridget

This is a repository to store all source files related to the development of Fridget. Follow the instructions below to set up the project in your local repo, and create PRs.

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 -- this step is not needed if you have used JDK 11 in a previous Intellij project.
   • In the same dialog, you may have to set the Project language level field to the SDK default option.
2. Import the project as a Gradle project, as described here.
3. Verify the set up: After the importing is complete, locate the src/main/java/seedu/fridget/Fridget.java file, right-click it, and choose Run Fridget.main(). If the setup is correct, you should see something like the below:

   > Task :compileJava
   > Task :processResources NO-SOURCE
   > Task :classes
   
   > Task :run
   
   
   
   
      ad88              88           88
     d8"                ""           88                             ,d
     88                              88                             88
   MM88MMM  8b,dPPYba,  88   ,adPPYb,88   ,adPPYb,d8   ,adPPYba,  MM88MMM
     88     88P'   "Y8  88  a8"    `Y88  a8"    `Y88  a8P_____88    88
     88     88          88  8b       88  8b       88  8PP"""""""    88
     88     88          88  "8a,   ,d88  "8a,   ,d88  "8b,   ,aa    88,
     88     88          88   `"8bbdP"Y8   `"YbbdP"Y8   `"Ybbd8"'    "Y888
                                          aa,    ,88
                                           "Y8bbdP"
   Hello!
   What would you like to do?
   __________________________________________
    ___________________________________________________
   |                      HEALTH!                      |
   |===================================================|
   |      ___            _         __        ______    |
   |     / _ \___ __ _  (_)__  ___/ /__ ____/ / / /    |
   |    / , _/ -_)  ' \/ / _ \/ _  / -_) __/_/_/_/     |
   |   /_/|_|\__/_/_/_/_/_//_/\_,_/\__/_/ (_|_|_)      |
   |   ---------------------------------------------   |
   |                                                   |
   |    "If you don't take time to take care of your   |
   |    health now, you're gonna have to make time     |
   |    for feeling sick and tired later."             |
   |                                                   |
   |            Always remember to eat more            |
   |              Fruits and Vegetables!               |
   |___________________________________________________|
   __________________________________________
   USER INPUT: 
   

   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.

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

• If you are new to JUnit, refer to the JUnit Tutorial at se-education.org/guides.

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.

CI using GitHub Actions

The project uses GitHub 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.
   If you are using this project template for a team project, go to the team fork on GitHub.
2. Click on the settings tab.
3. Scroll down to the GitHub Pages section.
4. Set the source as master branch /docs folder.
5. Optionally, use the choose a theme button to choose a theme for your documentation.