Repository navigation
User Documentation
bjleatherman edited this page Apr 6, 2025
·
6 revisions
This document is to show how to run and use a running application.
- You can follow the steps in the deployment document to run it in your local environment.
- Upon launching the application, the user will be shown any
remindersthat were set.- Turing the reminders off will be covered below
- The user should press the
enter keyto dismiss the reminders and enter the program

- The user is presented with 3 different options in the root menu and the option to exit the program.
- The menus can be navigated via the
arrow keysand theenter button-
Refuel Options- Log fuel purchased, view fuel purchase history, edit fuel purchase history -
Maintenance Options- Log maintenance events, view maintenance events, edit maintenance events -
Reminder Options- Set reminders, edit reminders, toggle alarms -
Exit- Exits the program
-

- When the user selects
Refuel Options, they are taken to the refuel menu. Here they are presented with 2 choices and the option to go back-
Add Refuel Event- Log information about a new fuel purchase -
All Refuel Events- View and edit past refuel events -
Go Back- Go back to the root menu
-

- When adding a refuel event, the user will be prompted to enter 3 values
- The amount of fuel purchased (unit agnostic)
- The current odometer value of the vehicle (unit agnostic)
- The amount of currency spent at the pump (unit agnostic)

- Upon selecting the
All Refuel Eventsoption, the user will be shown all of the refuel events that have been entered. - The
arrow keyscan theenter keycan be used to navigate and select a refuel event for editing-
Any Event- Edit the event -
Go Back- Returns the user to the previous menu
-

- When the user selects an event to edit, they will be presented with all of the fields that can be edited, the option to delete the event, and the option to go back
- The
arrow keyscan theenter keycan be used to navigate and select a field for editing - The Header text for this page will show the initial values for all fields for the current refuel event
-
Edit Date : ---- Takes the user to a sub menu where they can enter a newDateTimestring to update the date of the fuel purchase -
Edit Fuel Added: ---- Takes the user to a sub menu where they can enter a new value for the amount of fuel added -
Edit Odometer: ---- Takes the user to a sub menu where they can enter a new value for the odometer of their vehicle at time of purchase -
Edit Cost: ---- Takes the user to a sub menu where they can enter a new value for the cost of the fuel -
DELETE- Gives the user the option to delete the current event -
Go Back- Returns the user to the previous menu
-





- When the user selects
Maintenance Options, they are taken to the maintenance menu. Here they are presented with 2 choices and the option to go back-
Add Maintenance Event- Log information about maintenance performed -
All Maintenance Events- View and edit past maintenance events -
Go Back- Go back to the root menu
-

- When adding a maintenance event, the user will be prompted to enter 3 values
- The type of maintenance performed
- The current odometer value of the vehicle (unit agnostic)
- The amount of currency spent (unit agnostic)

- Upon selecting the
All Maintenance Eventsoption, the user will be shown all of the maintenance events that have been entered. - The
arrow keyscan theenter keycan be used to navigate and select a maintenance event for editing-
Any Event- Edit the event -
Go Back- Returns the user to the previous menu
-

- When the user selects an event to edit, they will be presented with all of the fields that can be edited, the option to delete the event, and the option to go back
- The
arrow keyscan theenter keycan be used to navigate and select a field for editing - The Header text for this page will show the initial values for all fields for the current refuel event
-
Edit Date : ---- Takes the user to a sub menu where they can enter a newDateTimestring to update the date of the fuel purchase -
Edit Maintenance Type: ---- Takes the user to a sub menu where they can enter a new value for the type of maintenance performed -
Edit Odometer: ---- Takes the user to a sub menu where they can enter a new value for the odometer of their vehicle at time of purchase -
Edit Cost: ---- Takes the user to a sub menu where they can enter a new value for the cost of the fuel -
DELETE- Gives the user the option to delete the current event -
Go Back- Returns the user to the previous menu
-






- When the user selects
Reminder Options, they are taken to the reminder menu. Here they are presented with 2 choices and the option to go back-
Add Reminder- Create a new reminder -
All Reminder Events- View and edit currently added reminders -
Go Back- Go back to the root menu
-

- When adding a reminder, the user will be prompted to enter 2 values
- The Name for the reminder that they are setting
- The
DateTimethat the reminder will go off (Note Alarms that are set for the past will be automatically set to silent. they can be turned on in theAll Reminder Events Menu)

- Upon selecting the
All Reminder Eventsoption, the user will be shown all of the reminder events that have been entered. - The
arrow keyscan theenter keycan be used to navigate and select a refuel event for editing-
Any Event- Edit the event -
Go Back- Returns the user to the previous menu
-

- When the user selects an event to edit, they will be presented with all of the fields that can be edited, the option to delete the event, and the option to go back
- The
arrow keyscan theenter keycan be used to navigate and select a field for editing - The Header text for this page will show the initial values for all fields for the current refuel event
-
Edit Reminder Text: ---- Takes the user to a sub menu where they can change the text of a reminder event -
Edit Reminder Time: ---- Takes the user to a sub menu where they can enter a newDateTimestring for the alarm to be associated with -
Turn Alarm: [ON/ OFF]- Allows the user to toggle if the alarm will be displayed when the program starts and if theReminder Timeis in the past -
DELETE- Gives the user the option to delete the current event -
Go Back- Returns the user to the previous menu
-



