Skip to content
This repository has been archived by the owner on Sep 15, 2024. It is now read-only.

Commit

Permalink
docs: auth + loan dash + loans
Browse files Browse the repository at this point in the history
  • Loading branch information
anaj00 committed Nov 30, 2023
1 parent d00dbe2 commit 5c6ad25
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/topics/Authenticating-Logging-In.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Authenticating/Logging In

Upon product turnover, the designated profile for login is exclusively the __'admin'__ profile, which will be promptly provided. Once granted access to the website, the __'admin'__ has the capability to establish supplementary profiles for other officers to utilize.
Upon product turnover, the designated profile for login is exclusively the ___admin___ profile, which will be promptly provided. Once granted access to the website, the ___admin___ has the capability to establish supplementary profiles for other officers to utilize.

## Logging In

To access the website, enter your respective credentials and click on the __'Log In'__ button. Additionally, an option to __'Remember me'__ is available, enabling users to have their login credentials remembered by their device. This allows swift access to the website without the need to input credentials every time.
To access the website, enter your respective credentials and click on the ___Log In___ button. Additionally, an option to ___Remember me___ is available, enabling users to have their login credentials remembered by their device. This allows swift access to the website without the need to input credentials every time.


<seealso>
Expand Down
48 changes: 48 additions & 0 deletions docs/topics/Loan-Dashboard.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,53 @@
# Loan Dashboard

The first thing once you enter the website is the ___Loan Dashboard___. This page houses all loans found in the database that are accepted.

Each row contains information on a certain loan. Information present are:
- Type of Loan
- Loanee; A button that can forward the user to the loanee's profile.
- Original Amount of Loan
- Outstanding Balance
- Status
- Due Date

## Sorting, Filtering, and Searching

Additionally, loans are sorted firstly by ___status___, then by ___due date___. Users can add their own sort by clicking the header of the certain field you would like to toggle. An arrow would then appear, pointing up for ascending, and pointing down for descending. Clicking the header once again would remove the sorting of that specific header. Also, the search bar found on the top right of the loan table can help filter specific fields the user wishes to search.

## Signifiers

The ___status___ and ___due date___ both have colors that signify a certain status.

### Status

For ___status___, the colors are as follows:

- Pending: <span style="color:purple;">`purple`</span>,
- Approved (for release): <span style="color:orange;">`orange`</span>,
- Approved (released): <span style="color:green;">`green`</span>,
- Rejected: <span style="color:red;">`red`</span>,
- Complete: <span style="color:blue;">`blue`</span>.

### Due Date

For ___due date___, this corresponds with the colors found in the settings tab (only accessible by the ___admin___). The colors are as follows:

- Demand Letter: <span style="color:red;">`red`</span>,
- Third Notice: <span style="color:orange;">`orange`</span>,
- Second Notice: <span style="color:blue;">`blue`</span>.
- First Notice: <span style="color:purple;">`purple`</span>,
- Reminder: <span style="color:gray;">`gray`</span>,

The amount of days for these colors to pop us as well is depending on the settings the ___admin___ has decided to put.

## Accessing the Loan Ledger

To access the loan ledger of a specific loan, find the loan to view, navigate to the right most part of the loan's row and find the arrow. This will forward the user to the loan's ledger page.





<seealso>
<category ref="loans">
<a href="Creating-a-Loan-Application.md" />
Expand Down
5 changes: 5 additions & 0 deletions docs/topics/Loans.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Loans

Loans can be viewed in two different ways:
* Through the loan dashboard, which contains all loans present in the system
* Through a member's profile, which contains all loans of that specific member.


<seealso>
<category ref="loans">
<a href="Loan-Dashboard.md" />
Expand Down

0 comments on commit 5c6ad25

Please sign in to comment.