Instructions and usage - melvinmajor/TodoList GitHub Wiki

Install instructions

Install Java 11+

Windows and macOS

  1. Go to AdoptOpenJDK
  2. Choose OpenJDK 11 (LTS) or any newer version available
  3. Choose HotSpot JVM
  4. Click on the button to access other platforms (Windows, Mac and Linux)
  5. Choose your OS and JRE if you just want to be able to run our app
  6. Follow the instructions to install

Linux

  1. You already know what to do
  2. Enjoy

Usage instructions

Run the app

In order to run the app, start a terminal in the bin directory and use this command to launch the server :

java -jar bin/todolist-server-1.0.jar [args]

Open an other terminal in the same directory and launch the CLI client :

java -jar bin/todolist-cli-1.0.jar [args]

Open an other terminal in the same directory and launch the GUI client :

java -jar bin/todolist-gui-0.1.jar

How to use the CLI

Available launch arguments:

-h | --help : Print this message

-s | --save : Save arguments to a file for next time

-p | --port : Set the server port

-H | --host : Set the server host

Once the CLI is successfuly launched, you'll be prompted to enter one of the following commands.

{ help | list | add | exit | remove | complete }

  • add: Add a task
  • remove: Remove a task
  • complete: Complete a task
  • list: List all tasks (sorted by due date and after by importance (High to Low))
  • help: print a help message containing a list of all available commands and a short explanation message
  • exit: Exit the app

How to use the Server

Available launch arguments:

-h | --help : Print this message

-s | --save : Save arguments to a file for next time

-p | --port : Set the server port

-H | --http-port : Enables and set the http server port

How to use the GUI

Launch it.