drustanyjt / ip

Project Fluffy

Fluffy

This is a develper guide for Fluffy, a personal assistant chatbot that helps a person to keep track of various tasks. It is optimized for use via a Command Line Interface (CLI) while having the benefits of a Graphical User Interface (GUI). If you are an avid keyboard user, Fluffy can help you keep track of your tasks faster than traditional GUI apps.

Setting up in Intellij

Prerequisites: JDK 11, update Intellij to the most recent version.

1. Open Intellij (if you are not in the welcome screen, click File > Close Project to close the existing project first)
2. Open the project into Intellij as follows:
   1. Click Open.
   2. Select the project directory, and click OK.
   3. If there are any further prompts, accept the defaults.
3. Configure the project to use JDK 11 (not other versions) as explained in here.
   In the same dialog, set the Project language level field to the SDK default option.
4. After that, locate the src/main/java/fluffy/Fluffy.java file, right-click it, and choose Run Fluffy.main().

Github Actions

We use Github Actions to automatically run tests and generate the JAR file. Have a look at the Actions tab in the repository to see the status of the workflow.