Merge pull request #13 from Dwigoric/Sprint-4

Sprint 4

.github/workflows/deployment_azure-app-service.yml

@@ -10,6 +10,15 @@ on:
       - 'Sprint-[0-9]'
   workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  WRS_INSTANCE: docs/ucwa
+  WRS_ARTIFACT: webHelpUCWA2-all.zip
+  WRS_DOCKER_VERSION: 232.10165.1
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -32,6 +41,44 @@ jobs:
           echo 'Install dependencies'
           yarn install --immutable
 
+      - name: Build jsdoc documentation
+        uses: andstor/jsdoc-action@v1
+        with:
+          source_dir: .
+          recurse: true
+          output_dir: ./public/docs/jsdoc
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.WRS_INSTANCE }}
+          artifact: ${{ env.WRS_ARTIFACT }}
+          docker-version: ${{ env.WRS_DOCKER_VERSION }}
+
+      - name: Upload Writerside documentation artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: wrs_docs
+          path: |
+              artifacts/${{ env.WRS_ARTIFACT }}
+              artifacts/report.json
+          retention-days: 7
+
+      - name: Test Writerside documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.WRS_INSTANCE }}
+
+      - name: Unzip Writerside artifact
+        uses: montudor/action-zip@v1
+        with:
+          args: unzip -qq artifacts/${{ env.WRS_ARTIFACT }} -d ./public/docs/code
+
+      - name: Remove unused files and folders
+        run: |
+          sudo rm -rf artifacts
+          git rm -rf docs 
+
       - name: 'Deploy to Azure Web App'
         uses: azure/webapps-deploy@v2
         id: deploy-to-webapp

.yarnrc.yml

@@ -4,4 +4,4 @@ enableGlobalCache: false
 
 nodeLinker: pnp
 
-yarnPath: .yarn/releases/yarn-4.0.1.cjs
+yarnPath: .yarn/releases/yarn-4.0.2.cjs

docs/c.list

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="loans" name="Loans" order="1" />
+    <category id="deposits" name="Deposits" order="2" />
+    <category id="profiles" name="Profiles" order="3" />
+    <category id="admin" name="Admin" order="4" />
+    <category id="uh" name="User Handbook" order="5" />
+    <category id="vue" name="Vue" order="98" />
+    <category id="ds" name="Development Standards" order="99"/>
+</categories>

docs/cfg/buildprofiles.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <variables></variables>
+    <build-profile instance="ucwa">
+        <variables>
+            <noindex-content>true</noindex-content>
+        </variables>
+    </build-profile>
+
+</buildprofiles>

docs/cfg/glossary.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd">
+<terms>
+    <term name="es6">ECMAScript 6 or ECMAScript 2015</term>
+</terms>

docs/topics/Adding-Deposit-Ledger-Transaction.md

@@ -0,0 +1,3 @@
+# Adding Deposit Ledger Transaction
+
+Start typing here...

docs/topics/Adding-Loan-Ledger-Transaction.md

@@ -0,0 +1,3 @@
+# Adding Loan Ledger Transaction
+
+Start typing here...

docs/topics/Admin.md

@@ -0,0 +1,22 @@
+# Admin
+
+<seealso>
+    <category ref="admin">
+        <a href="Changing-Password.md" />
+        <a href="Loan-and-Deposit-Settings.md" />
+        <a href="Notification-Settings.md" />
+    </category>
+    <category ref="uh">
+        <a href="Authenticating-Logging-In.md" />
+        <a href="Loans.md" />
+        <a href="Deposits.md" />
+        <a href="Profiles.md" />
+    </category>
+    <category ref="ds">
+        <a href="Naming.md" />
+        <a href="Comments.md" />
+        <a href="Code-Style.md" />
+        <a href="Git-Commit-Messages.md" />
+        <a href="Vue.md"></a>
+    </category>
+</seealso>

docs/topics/Authenticating-Logging-In.md

@@ -0,0 +1,41 @@
+# 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.
+
+<procedure title="Logging In" id="logging-in" type="steps">
+<step>Enter your credentials on the login form.</step>
+<step>
+<em>Optional</em>: Check the <strong>Remember me</strong> option if
+you wish to have your credentials remembered by your device.
+<warning>
+If you are using a public device, it is <strong>highly recommended</strong>
+that you do not check the <strong>Remember me</strong> option.
+</warning>
+</step>
+<step>Click on the <strong>Log In</strong> button.</step>
+<img src="login-page.png" alt="Login page screenshot" />
+<p>
+Checking the <strong>Remember me</strong> option will
+allow you to skip the login process on your next visit.
+</p>
+</procedure>
+
+
+<seealso>
+    <category ref="uh">
+        <a href="Admin.md" />
+        <a href="Loans.md" />
+        <a href="Deposits.md" />
+        <a href="Profiles.md" />
+    </category>
+    <category ref="ds">
+        <a href="Naming.md" />
+        <a href="Comments.md" />
+        <a href="Code-Style.md" />
+        <a href="Git-Commit-Messages.md" />
+        <a href="Vue.md"></a>
+    </category>
+</seealso>

docs/topics/Changing-Password.md

@@ -0,0 +1,21 @@
+# Changing Password
+
+<seealso>
+    <category ref="admin">
+        <a href="Loan-and-Deposit-Settings.md" />
+        <a href="Notification-Settings.md" />
+    </category>
+    <category ref="uh">
+        <a href="Authenticating-Logging-In.md" />
+        <a href="Loans.md" />
+        <a href="Deposits.md" />
+        <a href="Profiles.md" />
+    </category>
+    <category ref="ds">
+        <a href="Naming.md" />
+        <a href="Comments.md" />
+        <a href="Code-Style.md" />
+        <a href="Git-Commit-Messages.md" />
+        <a href="Vue.md"></a>
+    </category>
+</seealso>

docs/topics/Code-Style.md

@@ -0,0 +1,103 @@
+# Code Style
+
+> If you are using VS Code or WebStorm,
+> you can install the Prettier and ESLint extensions
+> to automatically format your code. Both repositories
+> contain Prettier and ESLint rules for code style.
+> You can find them in the `.prettierrc` and `.eslintrc` files
+> respectively.
+
+## Indentation
+
+All indentation must be done using **spaces**.
+One indentation level is equal to **4 spaces**.
+
+## Line Length
+
+All lines must not exceed **25 characters**.
+
+## Semicolons
+
+All statements must **NOT** end with a semicolon (`;`).
+
+## Braces
+
+All braces must be placed on the same line as the statement they refer to.
+
+### Example { id="braces-example" }
+
+```javascript
+if (true) {
+    // ...
+}
+```
+
+## Spacing
+
+### Operators
+
+All operators must be surrounded by **spaces**.
+
+#### Example { id="spacing-operators-example" }
+
+```javascript
+const a = 1 + 2
+```
+
+### Keywords
+
+All keywords must be followed by a **space**.
+
+#### Example { id="spacing-keywords-example" }
+
+```javascript
+if (true) {
+    // ...
+}
+```
+
+### Commas
+
+All commas must be followed by a **space**.
+
+#### Example { id="spacing-commas-example" }
+
+```javascript
+const a = [1, 2, 3]
+```
+
+### Sections
+
+All sections must be separated by **one blank line**.
+
+#### Example { id="spacing-sections-example" }
+
+```javascript
+function a() {
+    // ...
+}
+
+function b() {
+    // ...
+}
+```
+
+If a function definition contains a significant amount of code,
+it may be separated into sections. Make sure to add a comment
+above each section to describe what it does.
+
+<seealso>
+    <category ref="uh">
+        <a href="Admin.md" />
+        <a href="Authenticating-Logging-In.md" />
+        <a href="Loans.md" />
+        <a href="Deposits.md" />
+        <a href="Profiles.md" />
+    </category>
+    <category ref="ds">
+        <a href="Naming.md" />
+        <a href="Comments.md" />
+        <a href="Git-Commit-Messages.md" />
+        <a href="Vue.md"></a>
+    </category>
+</seealso>

docs/topics/Coding-Standards.md

@@ -0,0 +1,81 @@
+# Coding Standards
+
+This page contains the coding standards for the %product%.
+
+## General
+
+When developing the product, follow the
+<tooltip term='es6'>ES6</tooltip> standard.
+Both repositories are written in
+<tooltip term='es6'>ES6</tooltip>.
+
+## Variable Declaration
+
+<tldr>
+    <p><strong>Always</strong> use <code>const</code> unless you need to reassign the variable.</p>
+</tldr>
+
+All variables must be declared using the `const` keyword.
+However, some variables may be declared using the `let` keyword
+if they are to be reassigned later on.
+
+> Note that in JavaScript, `const` does not mean that the variable is immutable.
+> It only means that the variable cannot be reassigned.
+> If you have an object declared using `const`, you can still modify its properties.
+> If you want to make an object immutable, you can use the
+> `Object.freeze()` method.
+{ style='note' }
+
+### Example { id="variables-example" }
+
+```javascript
+// Do this
+const a = 1
+
+// NEVER this
+var a = 1
+
+// Sometimes this
+let a = 1
+```
+
+## Equality Operators
+
+<tldr>
+    <p><strong>Always</strong> use <code>===</code> and <code>!==</code>.</p>
+</tldr>
+
+All equality operators must be strict.
+This means that you must use `===` and `!==` instead of `==` and `!=`.
+
+### Example { id="equality-operators-example" }
+
+```javascript
+// Do this
+if (a === b) {
+    // ...
+}
+
+// NEVER this
+if (a == b) {
+    // ...
+}
+```
+
+
+<seealso>
+    <category ref="uh">
+        <a href="Admin.md" />
+        <a href="Authenticating-Logging-In.md" />
+        <a href="Loans.md" />
+        <a href="Deposits.md" />
+        <a href="Profiles.md" />
+    </category>
+    <category ref="ds">
+        <a href="Naming.md" />
+        <a href="Comments.md" />
+        <a href="Code-Style.md" />
+        <a href="Git-Commit-Messages.md" />
+        <a href="Vue.md"></a>
+    </category>
+</seealso>