From 43e83a349f4fa415f67c2b7faafb15fbf1a7d68f Mon Sep 17 00:00:00 2001
From: Damian Li <ke_2021@126.com>
Date: Sat, 7 Dec 2024 14:18:34 -0500
Subject: [PATCH] Deployed b14dd3e with MkDocs version: 1.6.1

---
 authentication/index.html | 18 +++++++++++++---
 index.html                | 43 ++++++++++++++++++++++++++++++++++++++-
 search/search_index.json  |  2 +-
 3 files changed, 58 insertions(+), 5 deletions(-)

diff --git a/authentication/index.html b/authentication/index.html
index 66fa1aa..9fad870 100644
--- a/authentication/index.html
+++ b/authentication/index.html
@@ -108,11 +108,23 @@ <h4 id="post-body-json">Post Body (<em>Json</em>)<a class="headerlink" href="#po
 <ul>
 <li>Response: (String or Status Code?)<ul>
 <li>If email exists:<ul>
-<li>password good: <code>STATUS_CODE::OK</code> (200)</li>
-<li>password bad: <code>STATUS_CODE::BAD_REQUEST</code> (400)</li>
+<li>password good: <ul>
+<li><code>STATUS_CODE</code>: <code>OK (200)</code>  </li>
+<li><code>Message</code>: "<code>username</code> Login successful"</li>
+</ul>
+</li>
+<li>password bad:<ul>
+<li><code>STATUS_CODE</code>:<code>BAD_REQUEST (400)</code> </li>
+<li><code>Message</code>: "Invalid password"</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>If email does not exist: <ul>
+<li><code>STATUS_CODE</code>: <code>CREATED (201)</code> </li>
+<li><code>Message</code>: "User successfully registered"</li>
 </ul>
 </li>
-<li>If email does not exist: <code>STATUS_CODE::CREATED</code> (201)</li>
 </ul>
 </li>
 </ul>
diff --git a/index.html b/index.html
index c003d43..ed8ebb5 100644
--- a/index.html
+++ b/index.html
@@ -114,6 +114,47 @@ <h1 id="backend-documentation">Backend Documentation<a class="headerlink" href="
 <h2 id="api">API<a class="headerlink" href="#api" title="Permanent link">&para;</a></h2>
 <h3 id="authentication"><a href="authentication/">Authentication</a><a class="headerlink" href="#authentication" title="Permanent link">&para;</a></h3>
 <h3 id="account-management"><a href="account/">Account Management</a><a class="headerlink" href="#account-management" title="Permanent link">&para;</a></h3>
+<table>
+<thead>
+<tr>
+<th>Category</th>
+<th>API</th>
+<th>Done or Not</th>
+<th>Time Finished</th>
+<th>Link to Docs</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Authentication</td>
+<td><code>/signup</code></td>
+<td>✅</td>
+<td>2024-12-07 2:00pm</td>
+<td><a href="authentication/#signup-post">View Docs</a></td>
+</tr>
+<tr>
+<td>Account Management</td>
+<td><code>/account_create</code></td>
+<td></td>
+<td></td>
+<td><a href="account/#create-new-account-for-user-post">View Docs</a></td>
+</tr>
+<tr>
+<td>Account Management</td>
+<td><code>/account_summary</code></td>
+<td></td>
+<td></td>
+<td><a href="account/#get-account-overview-for-user-get">View Docs</a></td>
+</tr>
+<tr>
+<td>Account Management</td>
+<td><code>/account_detail</code></td>
+<td></td>
+<td></td>
+<td><a href="account/#get-account-detailed-view-for-user-get">View Docs</a></td>
+</tr>
+</tbody>
+</table>
 <h2 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h2>
 <h3 id="update-documentation">Update Documentation<a class="headerlink" href="#update-documentation" title="Permanent link">&para;</a></h3>
 <h4 id="clone-project">Clone project<a class="headerlink" href="#clone-project" title="Permanent link">&para;</a></h4>
@@ -195,5 +236,5 @@ <h2 id="project-layout">Project layout<a class="headerlink" href="#project-layou
 
 <!--
 MkDocs version : 1.6.1
-Build Date UTC : 2024-12-07 04:39:30.722511+00:00
+Build Date UTC : 2024-12-07 19:18:34.083114+00:00
 -->
diff --git a/search/search_index.json b/search/search_index.json
index 663f39c..4e7a148 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Backend Documentation \u00b6 API \u00b6 Authentication \u00b6 Account Management \u00b6 Quick Start \u00b6 Update Documentation \u00b6 Clone project \u00b6 git clone https://github.com/FinTrak-Solutions/Backend.git Install virtual env \u00b6 cd Backend virtualenv venv source venv/bin/activate pip3 install mkdocs Goto dir \u00b6 cd Documentation Modify .md in docs/ \u00b6 # check, update locally mkdocs serve # modify .md in docs/ Build and deploy \u00b6 # build and deploy mkdocs build mkdocs gh-deploy Database Schema \u00b6 Can be found here Project layout \u00b6 TBD","title":"Home"},{"location":"#backend-documentation","text":"","title":"Backend Documentation"},{"location":"#api","text":"","title":"API"},{"location":"#authentication","text":"","title":"Authentication"},{"location":"#account-management","text":"","title":"Account Management"},{"location":"#quick-start","text":"","title":"Quick Start"},{"location":"#update-documentation","text":"","title":"Update Documentation"},{"location":"#clone-project","text":"git clone https://github.com/FinTrak-Solutions/Backend.git","title":"Clone project"},{"location":"#install-virtual-env","text":"cd Backend virtualenv venv source venv/bin/activate pip3 install mkdocs","title":"Install virtual env"},{"location":"#goto-dir","text":"cd Documentation","title":"Goto dir"},{"location":"#modify-md-in-docs","text":"# check, update locally mkdocs serve # modify .md in docs/","title":"Modify .md in docs/"},{"location":"#build-and-deploy","text":"# build and deploy mkdocs build mkdocs gh-deploy","title":"Build and deploy"},{"location":"#database-schema","text":"Can be found here","title":"Database Schema"},{"location":"#project-layout","text":"TBD","title":"Project layout"},{"location":"account/","text":"Account Management \u00b6 Create New Account for User POST \u00b6 API \u00b6 http://127.0.0.1:8000/account_create Request: { \"email\": \"test@example.com\", \"type\": \"credit\", \"account_name\": \"td_credit\", \"init_balance(optional)\": -200 } Response: Successfully created: STATUS_CODE::CREATED (201) Failed to create (e.g. account name already exists): STATUS_CODE::BAD_REQUEST (400) Get Account Overview for User GET \u00b6 API \u00b6 http://127.0.0.1:8000/account_summary Request: { \"email\": \"test@example.com\" } Response: { \"account1\": \"888.88CAD\", \"account2\": \"666.66CAD\" } Get Account Detailed View for User GET \u00b6 API \u00b6 http://127.0.0.1:8000/account_details Request: { \"email\": \"test@example.com\", \"account_name\": \"td_credit\" } Response: [ { \"1\": \"TBD\" }, { \"2\": \"TBD\" } ]","title":"Account Management"},{"location":"account/#account-management","text":"","title":"Account Management"},{"location":"account/#create-new-account-for-user-post","text":"","title":"Create New Account for User POST"},{"location":"account/#api","text":"http://127.0.0.1:8000/account_create Request: { \"email\": \"test@example.com\", \"type\": \"credit\", \"account_name\": \"td_credit\", \"init_balance(optional)\": -200 } Response: Successfully created: STATUS_CODE::CREATED (201) Failed to create (e.g. account name already exists): STATUS_CODE::BAD_REQUEST (400)","title":"API"},{"location":"account/#get-account-overview-for-user-get","text":"","title":"Get Account Overview for User GET"},{"location":"account/#api_1","text":"http://127.0.0.1:8000/account_summary Request: { \"email\": \"test@example.com\" } Response: { \"account1\": \"888.88CAD\", \"account2\": \"666.66CAD\" }","title":"API"},{"location":"account/#get-account-detailed-view-for-user-get","text":"","title":"Get Account Detailed View for User GET"},{"location":"account/#api_2","text":"http://127.0.0.1:8000/account_details Request: { \"email\": \"test@example.com\", \"account_name\": \"td_credit\" } Response: [ { \"1\": \"TBD\" }, { \"2\": \"TBD\" } ]","title":"API"},{"location":"authentication/","text":"Authentication \u00b6 Signup POST \u00b6 API \u00b6 http://127.0.0.1:8000/signup Post Body ( Json ) \u00b6 Request: { \"username\": \"John Wick\", \"email\": \"test@example.com\", \"password\": \"123456\" } Response: (String or Status Code?) If email exists: password good: STATUS_CODE::OK (200) password bad: STATUS_CODE::BAD_REQUEST (400) If email does not exist: STATUS_CODE::CREATED (201)","title":"Authentication"},{"location":"authentication/#authentication","text":"","title":"Authentication"},{"location":"authentication/#signup-post","text":"","title":"Signup POST"},{"location":"authentication/#api","text":"http://127.0.0.1:8000/signup","title":"API"},{"location":"authentication/#post-body-json","text":"Request: { \"username\": \"John Wick\", \"email\": \"test@example.com\", \"password\": \"123456\" } Response: (String or Status Code?) If email exists: password good: STATUS_CODE::OK (200) password bad: STATUS_CODE::BAD_REQUEST (400) If email does not exist: STATUS_CODE::CREATED (201)","title":"Post Body (Json)"},{"location":"database/","text":"Database Schema Documentation \u00b6 Introduction \u00b6 This document outlines the updated database schema for the financial tracker application backend, utilizing Rust Rocket for REST API handling, Diesel for database interaction, and PostgreSQL as the database. The schema is designed to efficiently store and manage user information , financial accounts , transactions , budgets , and categories , ensuring data scalability and consistency. Table of Contents \u00b6 User Table Account Table Transaction Table Category Table Summary of Updates User Table \u00b6 Description \u00b6 Stores user credentials and personal information. Each user is uniquely identified and can have multiple accounts, transactions, and categories associated with them. Schema \u00b6 Field Name Data Type Constraints Description id SERIAL Primary Key Unique identifier for each user. email TEXT Unique, Not Null User's email address. password TEXT Not Null Hashed password for security. username TEXT Not Null User's unique username. Account Table \u00b6 Description \u00b6 Represents financial accounts linked to users. Each account belongs to a user and holds financial transactions. Schema \u00b6 Field Name Data Type Constraints Description account_id SERIAL Primary Key Unique identifier for each account. email TEXT Foreign Key ( User.email ), Not Null Email of the account owner. account_type TEXT Not Null Type of the account (e.g., Credit , Debit , Savings ). account_name TEXT Not Null A descriptive name for the account. Transaction Table \u00b6 Description \u00b6 Logs all financial transactions associated with accounts. Each transaction records details like amount, timestamp, and category. Schema \u00b6 Field Name Data Type Constraints Description trans_id SERIAL Primary Key Unique identifier for each transaction. email TEXT Foreign Key ( User.email ), Not Null Email of the user linked to the transaction. category_id INTEGER Foreign Key ( Category.category_id ) Category classification for the transaction. amount FLOAT8 Not Null Transaction amount (positive or negative). notes TEXT (nullable) Optional Additional notes for the transaction. Category Table \u00b6 Description \u00b6 Provides a way to classify transactions into categories, allowing for detailed financial tracking and reporting. Schema \u00b6 Field Name Data Type Constraints Description category_id SERIAL Primary Key Unique identifier for each category. email TEXT Foreign Key ( User.email ), Not Null Email of the user who owns the category. nickname TEXT Not Null A descriptive name for the category. category_type TEXT Not Null Type of category (e.g., Food , Bills ). budget FLOAT8 Optional Budget associated with this category. budget_freq TEXT Optional Budget frequency ( Daily , Weekly , etc.). Summary of Updates \u00b6 Primary Keys : Added id fields as primary keys in tables where they were missing. Foreign Key Relationships : email links multiple tables to the users table for referential integrity. category_id links the transactions table to the categories table. Field Updates : Added account_name to the accounts table for better account identification. Ensured foreign key constraints for better data consistency. Enumerations and Constraints : Categories and budgets allow classification for better financial tracking. Transaction amounts support both positive and negative values. Scalability and Performance : Schema supports detailed tracking and reporting, optimized for scalability and extensibility.","title":"Database Schema"},{"location":"database/#database-schema-documentation","text":"","title":"Database Schema Documentation"},{"location":"database/#introduction","text":"This document outlines the updated database schema for the financial tracker application backend, utilizing Rust Rocket for REST API handling, Diesel for database interaction, and PostgreSQL as the database. The schema is designed to efficiently store and manage user information , financial accounts , transactions , budgets , and categories , ensuring data scalability and consistency.","title":"Introduction"},{"location":"database/#table-of-contents","text":"User Table Account Table Transaction Table Category Table Summary of Updates","title":"Table of Contents"},{"location":"database/#user-table","text":"","title":"User Table"},{"location":"database/#description","text":"Stores user credentials and personal information. Each user is uniquely identified and can have multiple accounts, transactions, and categories associated with them.","title":"Description"},{"location":"database/#schema","text":"Field Name Data Type Constraints Description id SERIAL Primary Key Unique identifier for each user. email TEXT Unique, Not Null User's email address. password TEXT Not Null Hashed password for security. username TEXT Not Null User's unique username.","title":"Schema"},{"location":"database/#account-table","text":"","title":"Account Table"},{"location":"database/#description_1","text":"Represents financial accounts linked to users. Each account belongs to a user and holds financial transactions.","title":"Description"},{"location":"database/#schema_1","text":"Field Name Data Type Constraints Description account_id SERIAL Primary Key Unique identifier for each account. email TEXT Foreign Key ( User.email ), Not Null Email of the account owner. account_type TEXT Not Null Type of the account (e.g., Credit , Debit , Savings ). account_name TEXT Not Null A descriptive name for the account.","title":"Schema"},{"location":"database/#transaction-table","text":"","title":"Transaction Table"},{"location":"database/#description_2","text":"Logs all financial transactions associated with accounts. Each transaction records details like amount, timestamp, and category.","title":"Description"},{"location":"database/#schema_2","text":"Field Name Data Type Constraints Description trans_id SERIAL Primary Key Unique identifier for each transaction. email TEXT Foreign Key ( User.email ), Not Null Email of the user linked to the transaction. category_id INTEGER Foreign Key ( Category.category_id ) Category classification for the transaction. amount FLOAT8 Not Null Transaction amount (positive or negative). notes TEXT (nullable) Optional Additional notes for the transaction.","title":"Schema"},{"location":"database/#category-table","text":"","title":"Category Table"},{"location":"database/#description_3","text":"Provides a way to classify transactions into categories, allowing for detailed financial tracking and reporting.","title":"Description"},{"location":"database/#schema_3","text":"Field Name Data Type Constraints Description category_id SERIAL Primary Key Unique identifier for each category. email TEXT Foreign Key ( User.email ), Not Null Email of the user who owns the category. nickname TEXT Not Null A descriptive name for the category. category_type TEXT Not Null Type of category (e.g., Food , Bills ). budget FLOAT8 Optional Budget associated with this category. budget_freq TEXT Optional Budget frequency ( Daily , Weekly , etc.).","title":"Schema"},{"location":"database/#summary-of-updates","text":"Primary Keys : Added id fields as primary keys in tables where they were missing. Foreign Key Relationships : email links multiple tables to the users table for referential integrity. category_id links the transactions table to the categories table. Field Updates : Added account_name to the accounts table for better account identification. Ensured foreign key constraints for better data consistency. Enumerations and Constraints : Categories and budgets allow classification for better financial tracking. Transaction amounts support both positive and negative values. Scalability and Performance : Schema supports detailed tracking and reporting, optimized for scalability and extensibility.","title":"Summary of Updates"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Backend Documentation \u00b6 API \u00b6 Authentication \u00b6 Account Management \u00b6 Category API Done or Not Time Finished Link to Docs Authentication /signup \u2705 2024-12-07 2:00pm View Docs Account Management /account_create View Docs Account Management /account_summary View Docs Account Management /account_detail View Docs Quick Start \u00b6 Update Documentation \u00b6 Clone project \u00b6 git clone https://github.com/FinTrak-Solutions/Backend.git Install virtual env \u00b6 cd Backend virtualenv venv source venv/bin/activate pip3 install mkdocs Goto dir \u00b6 cd Documentation Modify .md in docs/ \u00b6 # check, update locally mkdocs serve # modify .md in docs/ Build and deploy \u00b6 # build and deploy mkdocs build mkdocs gh-deploy Database Schema \u00b6 Can be found here Project layout \u00b6 TBD","title":"Home"},{"location":"#backend-documentation","text":"","title":"Backend Documentation"},{"location":"#api","text":"","title":"API"},{"location":"#authentication","text":"","title":"Authentication"},{"location":"#account-management","text":"Category API Done or Not Time Finished Link to Docs Authentication /signup \u2705 2024-12-07 2:00pm View Docs Account Management /account_create View Docs Account Management /account_summary View Docs Account Management /account_detail View Docs","title":"Account Management"},{"location":"#quick-start","text":"","title":"Quick Start"},{"location":"#update-documentation","text":"","title":"Update Documentation"},{"location":"#clone-project","text":"git clone https://github.com/FinTrak-Solutions/Backend.git","title":"Clone project"},{"location":"#install-virtual-env","text":"cd Backend virtualenv venv source venv/bin/activate pip3 install mkdocs","title":"Install virtual env"},{"location":"#goto-dir","text":"cd Documentation","title":"Goto dir"},{"location":"#modify-md-in-docs","text":"# check, update locally mkdocs serve # modify .md in docs/","title":"Modify .md in docs/"},{"location":"#build-and-deploy","text":"# build and deploy mkdocs build mkdocs gh-deploy","title":"Build and deploy"},{"location":"#database-schema","text":"Can be found here","title":"Database Schema"},{"location":"#project-layout","text":"TBD","title":"Project layout"},{"location":"account/","text":"Account Management \u00b6 Create New Account for User POST \u00b6 API \u00b6 http://127.0.0.1:8000/account_create Request: { \"email\": \"test@example.com\", \"type\": \"credit\", \"account_name\": \"td_credit\", \"init_balance(optional)\": -200 } Response: Successfully created: STATUS_CODE::CREATED (201) Failed to create (e.g. account name already exists): STATUS_CODE::BAD_REQUEST (400) Get Account Overview for User GET \u00b6 API \u00b6 http://127.0.0.1:8000/account_summary Request: { \"email\": \"test@example.com\" } Response: { \"account1\": \"888.88CAD\", \"account2\": \"666.66CAD\" } Get Account Detailed View for User GET \u00b6 API \u00b6 http://127.0.0.1:8000/account_details Request: { \"email\": \"test@example.com\", \"account_name\": \"td_credit\" } Response: [ { \"1\": \"TBD\" }, { \"2\": \"TBD\" } ]","title":"Account Management"},{"location":"account/#account-management","text":"","title":"Account Management"},{"location":"account/#create-new-account-for-user-post","text":"","title":"Create New Account for User POST"},{"location":"account/#api","text":"http://127.0.0.1:8000/account_create Request: { \"email\": \"test@example.com\", \"type\": \"credit\", \"account_name\": \"td_credit\", \"init_balance(optional)\": -200 } Response: Successfully created: STATUS_CODE::CREATED (201) Failed to create (e.g. account name already exists): STATUS_CODE::BAD_REQUEST (400)","title":"API"},{"location":"account/#get-account-overview-for-user-get","text":"","title":"Get Account Overview for User GET"},{"location":"account/#api_1","text":"http://127.0.0.1:8000/account_summary Request: { \"email\": \"test@example.com\" } Response: { \"account1\": \"888.88CAD\", \"account2\": \"666.66CAD\" }","title":"API"},{"location":"account/#get-account-detailed-view-for-user-get","text":"","title":"Get Account Detailed View for User GET"},{"location":"account/#api_2","text":"http://127.0.0.1:8000/account_details Request: { \"email\": \"test@example.com\", \"account_name\": \"td_credit\" } Response: [ { \"1\": \"TBD\" }, { \"2\": \"TBD\" } ]","title":"API"},{"location":"authentication/","text":"Authentication \u00b6 Signup POST \u00b6 API \u00b6 http://127.0.0.1:8000/signup Post Body ( Json ) \u00b6 Request: { \"username\": \"John Wick\", \"email\": \"test@example.com\", \"password\": \"123456\" } Response: (String or Status Code?) If email exists: password good: STATUS_CODE : OK (200) Message : \" username Login successful\" password bad: STATUS_CODE : BAD_REQUEST (400) Message : \"Invalid password\" If email does not exist: STATUS_CODE : CREATED (201) Message : \"User successfully registered\"","title":"Authentication"},{"location":"authentication/#authentication","text":"","title":"Authentication"},{"location":"authentication/#signup-post","text":"","title":"Signup POST"},{"location":"authentication/#api","text":"http://127.0.0.1:8000/signup","title":"API"},{"location":"authentication/#post-body-json","text":"Request: { \"username\": \"John Wick\", \"email\": \"test@example.com\", \"password\": \"123456\" } Response: (String or Status Code?) If email exists: password good: STATUS_CODE : OK (200) Message : \" username Login successful\" password bad: STATUS_CODE : BAD_REQUEST (400) Message : \"Invalid password\" If email does not exist: STATUS_CODE : CREATED (201) Message : \"User successfully registered\"","title":"Post Body (Json)"},{"location":"database/","text":"Database Schema Documentation \u00b6 Introduction \u00b6 This document outlines the updated database schema for the financial tracker application backend, utilizing Rust Rocket for REST API handling, Diesel for database interaction, and PostgreSQL as the database. The schema is designed to efficiently store and manage user information , financial accounts , transactions , budgets , and categories , ensuring data scalability and consistency. Table of Contents \u00b6 User Table Account Table Transaction Table Category Table Summary of Updates User Table \u00b6 Description \u00b6 Stores user credentials and personal information. Each user is uniquely identified and can have multiple accounts, transactions, and categories associated with them. Schema \u00b6 Field Name Data Type Constraints Description id SERIAL Primary Key Unique identifier for each user. email TEXT Unique, Not Null User's email address. password TEXT Not Null Hashed password for security. username TEXT Not Null User's unique username. Account Table \u00b6 Description \u00b6 Represents financial accounts linked to users. Each account belongs to a user and holds financial transactions. Schema \u00b6 Field Name Data Type Constraints Description account_id SERIAL Primary Key Unique identifier for each account. email TEXT Foreign Key ( User.email ), Not Null Email of the account owner. account_type TEXT Not Null Type of the account (e.g., Credit , Debit , Savings ). account_name TEXT Not Null A descriptive name for the account. Transaction Table \u00b6 Description \u00b6 Logs all financial transactions associated with accounts. Each transaction records details like amount, timestamp, and category. Schema \u00b6 Field Name Data Type Constraints Description trans_id SERIAL Primary Key Unique identifier for each transaction. email TEXT Foreign Key ( User.email ), Not Null Email of the user linked to the transaction. category_id INTEGER Foreign Key ( Category.category_id ) Category classification for the transaction. amount FLOAT8 Not Null Transaction amount (positive or negative). notes TEXT (nullable) Optional Additional notes for the transaction. Category Table \u00b6 Description \u00b6 Provides a way to classify transactions into categories, allowing for detailed financial tracking and reporting. Schema \u00b6 Field Name Data Type Constraints Description category_id SERIAL Primary Key Unique identifier for each category. email TEXT Foreign Key ( User.email ), Not Null Email of the user who owns the category. nickname TEXT Not Null A descriptive name for the category. category_type TEXT Not Null Type of category (e.g., Food , Bills ). budget FLOAT8 Optional Budget associated with this category. budget_freq TEXT Optional Budget frequency ( Daily , Weekly , etc.). Summary of Updates \u00b6 Primary Keys : Added id fields as primary keys in tables where they were missing. Foreign Key Relationships : email links multiple tables to the users table for referential integrity. category_id links the transactions table to the categories table. Field Updates : Added account_name to the accounts table for better account identification. Ensured foreign key constraints for better data consistency. Enumerations and Constraints : Categories and budgets allow classification for better financial tracking. Transaction amounts support both positive and negative values. Scalability and Performance : Schema supports detailed tracking and reporting, optimized for scalability and extensibility.","title":"Database Schema"},{"location":"database/#database-schema-documentation","text":"","title":"Database Schema Documentation"},{"location":"database/#introduction","text":"This document outlines the updated database schema for the financial tracker application backend, utilizing Rust Rocket for REST API handling, Diesel for database interaction, and PostgreSQL as the database. The schema is designed to efficiently store and manage user information , financial accounts , transactions , budgets , and categories , ensuring data scalability and consistency.","title":"Introduction"},{"location":"database/#table-of-contents","text":"User Table Account Table Transaction Table Category Table Summary of Updates","title":"Table of Contents"},{"location":"database/#user-table","text":"","title":"User Table"},{"location":"database/#description","text":"Stores user credentials and personal information. Each user is uniquely identified and can have multiple accounts, transactions, and categories associated with them.","title":"Description"},{"location":"database/#schema","text":"Field Name Data Type Constraints Description id SERIAL Primary Key Unique identifier for each user. email TEXT Unique, Not Null User's email address. password TEXT Not Null Hashed password for security. username TEXT Not Null User's unique username.","title":"Schema"},{"location":"database/#account-table","text":"","title":"Account Table"},{"location":"database/#description_1","text":"Represents financial accounts linked to users. Each account belongs to a user and holds financial transactions.","title":"Description"},{"location":"database/#schema_1","text":"Field Name Data Type Constraints Description account_id SERIAL Primary Key Unique identifier for each account. email TEXT Foreign Key ( User.email ), Not Null Email of the account owner. account_type TEXT Not Null Type of the account (e.g., Credit , Debit , Savings ). account_name TEXT Not Null A descriptive name for the account.","title":"Schema"},{"location":"database/#transaction-table","text":"","title":"Transaction Table"},{"location":"database/#description_2","text":"Logs all financial transactions associated with accounts. Each transaction records details like amount, timestamp, and category.","title":"Description"},{"location":"database/#schema_2","text":"Field Name Data Type Constraints Description trans_id SERIAL Primary Key Unique identifier for each transaction. email TEXT Foreign Key ( User.email ), Not Null Email of the user linked to the transaction. category_id INTEGER Foreign Key ( Category.category_id ) Category classification for the transaction. amount FLOAT8 Not Null Transaction amount (positive or negative). notes TEXT (nullable) Optional Additional notes for the transaction.","title":"Schema"},{"location":"database/#category-table","text":"","title":"Category Table"},{"location":"database/#description_3","text":"Provides a way to classify transactions into categories, allowing for detailed financial tracking and reporting.","title":"Description"},{"location":"database/#schema_3","text":"Field Name Data Type Constraints Description category_id SERIAL Primary Key Unique identifier for each category. email TEXT Foreign Key ( User.email ), Not Null Email of the user who owns the category. nickname TEXT Not Null A descriptive name for the category. category_type TEXT Not Null Type of category (e.g., Food , Bills ). budget FLOAT8 Optional Budget associated with this category. budget_freq TEXT Optional Budget frequency ( Daily , Weekly , etc.).","title":"Schema"},{"location":"database/#summary-of-updates","text":"Primary Keys : Added id fields as primary keys in tables where they were missing. Foreign Key Relationships : email links multiple tables to the users table for referential integrity. category_id links the transactions table to the categories table. Field Updates : Added account_name to the accounts table for better account identification. Ensured foreign key constraints for better data consistency. Enumerations and Constraints : Categories and budgets allow classification for better financial tracking. Transaction amounts support both positive and negative values. Scalability and Performance : Schema supports detailed tracking and reporting, optimized for scalability and extensibility.","title":"Summary of Updates"}]}
\ No newline at end of file