diff --git a/docs/c.list b/docs/c.list index e00b609..956ce0d 100644 --- a/docs/c.list +++ b/docs/c.list @@ -7,5 +7,6 @@ + \ No newline at end of file diff --git a/docs/topics/Admin.md b/docs/topics/Admin.md index 9e32ae8..6fd5475 100644 --- a/docs/topics/Admin.md +++ b/docs/topics/Admin.md @@ -17,5 +17,6 @@ + diff --git a/docs/topics/Authenticating-Logging-In.md b/docs/topics/Authenticating-Logging-In.md index 057fdbc..31632b1 100644 --- a/docs/topics/Authenticating-Logging-In.md +++ b/docs/topics/Authenticating-Logging-In.md @@ -12,5 +12,6 @@ + diff --git a/docs/topics/Changing-Password.md b/docs/topics/Changing-Password.md index a4ff8df..41fdb96 100644 --- a/docs/topics/Changing-Password.md +++ b/docs/topics/Changing-Password.md @@ -16,5 +16,6 @@ + diff --git a/docs/topics/Code-Style.md b/docs/topics/Code-Style.md index 5a4db5e..a9e9943 100644 --- a/docs/topics/Code-Style.md +++ b/docs/topics/Code-Style.md @@ -98,5 +98,6 @@ above each section to describe what it does. + diff --git a/docs/topics/Coding-Standards.md b/docs/topics/Coding-Standards.md index cbdcc57..b9a7b1d 100644 --- a/docs/topics/Coding-Standards.md +++ b/docs/topics/Coding-Standards.md @@ -51,5 +51,6 @@ let a = 1 + diff --git a/docs/topics/Comments.md b/docs/topics/Comments.md index 741a772..7bf76b3 100644 --- a/docs/topics/Comments.md +++ b/docs/topics/Comments.md @@ -56,5 +56,6 @@ Block comments for methods must contain at least the following: + diff --git a/docs/topics/Components.md b/docs/topics/Components.md new file mode 100644 index 0000000..90d920a --- /dev/null +++ b/docs/topics/Components.md @@ -0,0 +1,74 @@ +# Components + +Components are the building blocks of Vue applications. A component is +essentially a Vue instance with pre-defined options. Registering a component in +Vue using Composition is straightforward: + +```javascript + +```` +```html + +``` +```html + +``` + +The sample component above is a simple button that increments a counter when +clicked. + +## Structure + +For this project, the setup script must be first, followed by the template and +then the style. The style is optional. + +The setup script is a single script tag with the attribute `setup`. +The template is a single template tag. +The style is a single style tag with the attribute `scoped`. + +## Directories + +View components are stored in the `src/views` directory, while +components that are used by views are stored in the `src/components`. + + + + + + + + + + + + + + + + + + + diff --git a/docs/topics/Creating-New-Deposit.md b/docs/topics/Creating-New-Deposit.md index ca27414..c24f3b7 100644 --- a/docs/topics/Creating-New-Deposit.md +++ b/docs/topics/Creating-New-Deposit.md @@ -15,5 +15,6 @@ + diff --git a/docs/topics/Creating-a-Loan-Application.md b/docs/topics/Creating-a-Loan-Application.md index 2268f92..910eed7 100644 --- a/docs/topics/Creating-a-Loan-Application.md +++ b/docs/topics/Creating-a-Loan-Application.md @@ -16,5 +16,6 @@ + diff --git a/docs/topics/Deposit-Dashboard.md b/docs/topics/Deposit-Dashboard.md index cb4dd3e..a1104a1 100644 --- a/docs/topics/Deposit-Dashboard.md +++ b/docs/topics/Deposit-Dashboard.md @@ -15,5 +15,6 @@ + diff --git a/docs/topics/Deposits.md b/docs/topics/Deposits.md index 851c6ad..43eb3b7 100644 --- a/docs/topics/Deposits.md +++ b/docs/topics/Deposits.md @@ -16,5 +16,6 @@ + diff --git a/docs/topics/Introduction.md b/docs/topics/Introduction.md index 077e02f..7d1699e 100644 --- a/docs/topics/Introduction.md +++ b/docs/topics/Introduction.md @@ -57,5 +57,6 @@ usability improvements, or feature requests. + diff --git a/docs/topics/Loan-Approval-Rejection.md b/docs/topics/Loan-Approval-Rejection.md index c735ea0..e94b301 100644 --- a/docs/topics/Loan-Approval-Rejection.md +++ b/docs/topics/Loan-Approval-Rejection.md @@ -16,5 +16,6 @@ + diff --git a/docs/topics/Loan-Dashboard.md b/docs/topics/Loan-Dashboard.md index 675b6c3..66facfa 100644 --- a/docs/topics/Loan-Dashboard.md +++ b/docs/topics/Loan-Dashboard.md @@ -16,5 +16,6 @@ + diff --git a/docs/topics/Loan-and-Deposit-Settings.md b/docs/topics/Loan-and-Deposit-Settings.md index c37f1a5..3e44ffc 100644 --- a/docs/topics/Loan-and-Deposit-Settings.md +++ b/docs/topics/Loan-and-Deposit-Settings.md @@ -16,5 +16,6 @@ + diff --git a/docs/topics/Loans.md b/docs/topics/Loans.md index 71203e2..030b7cb 100644 --- a/docs/topics/Loans.md +++ b/docs/topics/Loans.md @@ -17,5 +17,6 @@ + diff --git a/docs/topics/Member-Profiles.md b/docs/topics/Member-Profiles.md index 9c8ad33..30db0e7 100644 --- a/docs/topics/Member-Profiles.md +++ b/docs/topics/Member-Profiles.md @@ -15,5 +15,6 @@ + diff --git a/docs/topics/Naming.md b/docs/topics/Naming.md index 8a720cf..4f0b001 100644 --- a/docs/topics/Naming.md +++ b/docs/topics/Naming.md @@ -39,5 +39,6 @@ All classes must be named in `PascalCase`. + diff --git a/docs/topics/Notification-Settings.md b/docs/topics/Notification-Settings.md index 5691736..65e167e 100644 --- a/docs/topics/Notification-Settings.md +++ b/docs/topics/Notification-Settings.md @@ -16,5 +16,6 @@ + diff --git a/docs/topics/Officer-Profiles.md b/docs/topics/Officer-Profiles.md index 7b90c28..69fca0b 100644 --- a/docs/topics/Officer-Profiles.md +++ b/docs/topics/Officer-Profiles.md @@ -15,5 +15,6 @@ + diff --git a/docs/topics/Profiles.md b/docs/topics/Profiles.md index a9f4a7b..64ba20a 100644 --- a/docs/topics/Profiles.md +++ b/docs/topics/Profiles.md @@ -16,5 +16,6 @@ + diff --git a/docs/topics/User-Handbook.md b/docs/topics/User-Handbook.md index 31e2766..bf1e256 100644 --- a/docs/topics/User-Handbook.md +++ b/docs/topics/User-Handbook.md @@ -13,5 +13,6 @@ + diff --git a/docs/topics/Vue.md b/docs/topics/Vue.md new file mode 100644 index 0000000..9498213 --- /dev/null +++ b/docs/topics/Vue.md @@ -0,0 +1,43 @@ +# Vue + +The frontend is built with Vue.js, which is also subject to our +. + +## Vue.js + +Vue.js is a progressive framework for building user interfaces. Unlike other +monolithic frameworks, Vue is designed from the ground up to be incrementally +adoptable. The core library is focused on the view layer only, and is easy to +pick up and integrate with other libraries or existing projects. On the other +hand, Vue is also perfectly capable of powering sophisticated Single-Page +Applications when used in combination with modern tooling and supporting +libraries. + +For this project, we use Vue.js 3 built with [Vite](https://vitejs.dev/). + +## Vue API + +The Vue API is available +here online. +We will be using the Composition API, which is available +here online. + + + + + + + + + + + + + + + + + + + + diff --git a/docs/topics/Vuetify.md b/docs/topics/Vuetify.md new file mode 100644 index 0000000..7404a59 --- /dev/null +++ b/docs/topics/Vuetify.md @@ -0,0 +1,35 @@ +# Vuetify + +This project largely uses [Vuetify](https://vuetifyjs.com/en/) for its +components. Vuetify is a Material Design component framework for Vue.js. It aims +to provide clean, semantic and reusable components that make building your +application a breeze. + +## Vuetify API + +The Vuetify API is available +[here online](https://vuetifyjs.com/en/api/vuetify/). + +## Classes + +Vuetify uses classes to style components. These classes are exposed to the +whole application, so they can be used in the `class` tag of any component. + + + + + + + + + + + + + + + + + + + diff --git a/docs/ucwa.tree b/docs/ucwa.tree index 1e4836a..d6a6bf8 100644 --- a/docs/ucwa.tree +++ b/docs/ucwa.tree @@ -33,6 +33,10 @@ + + + + \ No newline at end of file