Skip to content
Christian Zaccaria edited this page Mar 30, 2022 · 4 revisions

Welcome to the notes-app-console wiki!

In this Wiki page, I go in more detail about the project. This is a working program that functions like a notepad, these notes can be stored and loaded when needed, which can be very useful to keep track of things.

This project was developed using Kotlin (programming language), Gradle (automation tool), JUNIT5 (testing framework).

Project Description and Features

🗒️ The Notes App is a Menu-Driven Console App that allows the user to perform the following on a List of Notes:

1. Add a Note 📄

When a note is going to be added, the user is prompted to enter a Title for the note, the Contents for it, the level of Priority from 1-low to 5-high, the category [Hobby, College, Holiday, Work, Misc], and a status [1-todo, 2-doing, 3-done]. Once done, the note will automatically be Active, which can later on be archived if needed.

2. List Notes 📂

Screenshot (265)

As we can see above, when we choose the List Notes option, we get more options to filter the list as the user wishes.

3. Update a Note 📝

When updating a note, the user can filter the list of notes and select the note to be updated by its index number. Every attribute can be edited.

4. Delete a Note 🗑️

When deleting a note, the user can filter the list of notes and select the note to be deleted by its index number.

5. Archive a Note :file_cabinet:

When archiving a note, the user will get a list of Active notes, and will need to select the note to be Archived by its index number.

6. Search a Note :mag:

The user can search for a note by the name of the Title.

7. Save Notes ⤴️

The user can save the notes that were created to a .XML, .JSON, or .YAML file.

8. Load Notes :arrows_counterclockwise:

The user can load the notes that were previously saved to file.


This app was developed using Kotlin ⭐⭐⭐⭐⭐


Project Purpose

This app lets the user add their own notes, list them, edit them, and also delete them. Moreover, the user can search for notes by priority, category or by title. Some examples of how it can be used:

  • Write down a to-do list.
  • Grocery list.
  • Notes of things you want to remember.
  • You can make a list based on level of priority (1-low, 2, 3, 4, 5-high)

Getting Started with the Project

Once you run the app, you will be prompted to enter a number to choose an option from the menu.

Screenshot (263) Screenshot (267)

Additional Information

The functionalities of the app have been tested using JUNIT5. All tests have passed. If any bugs encountered, please notify the Project Author 😃

Project Author / Contributers

🌟 Christian Zaccaria (Software Systems Development Year 2)