______  __  __   __  ______  ______  ______  ______  __  __    
/\  ___\/\ \/\ "-.\ \/\__  _\/\  == \/\  __ \/\  ___\/\ \/ /    
\ \  __\\ \ \ \ \-.  \/_/\ \/\ \  __<\ \  __ \ \ \___\ \  _"-.  
 \ \_\   \ \_\ \_\\"\_\ \ \_\ \ \_\ \_\ \_\ \_\ \_____\ \_\ \_\ 
  \/_/    \/_/\/_/ \/_/  \/_/  \/_/ /_/\/_/\/_/\/_____/\/_/\/_/

FinTrack Backend

Online Documentation

---

🌐 API

🔐 Authentication

API	Status	Time Finished	Link to Docs
/signup	✅ Complete	2024-12-07 2:00pm	View Docs

---

📘 Account Management

API	Status	Time Finished	Link to Docs
/account_create	✅ Complete	2024-12-07 3:10pm	View Docs
/account_summary?email=<>	✅ Complete	2024-12-07 3:40pm	View Docs
/delete_account?email=<>&account_name=<>	✅ Complete	2024-12-07 4:20pm	View Docs
/account_detail	❌ In Progress	TBD	View Docs

---

📦 Category Management

API	Status	Time Finished	Link to Docs
/category_create	✅ Complete	2024-12-07	View Docs
/category_summary?email=<>	✅ Complete	2024-12-07	View Docs
/delete_category?email=<>&category_nickname=<>	✅ Complete	2024-12-07	View Docs
/category_update?email=<>&field=<field_to_update>&category_nickname=<>&new_value=<>	✅ Complete	2024-12-07	View Docs

---

💸 Transaction Management

API	Status	Time Finished	Link to Docs
/add_trans	✅ Complete	2024-12-07 View Docs
/delete_trans?trans_id=<>	✅ Complete	2024-12- 07 View Docs
/category_trans?category_name=<>&email=<>	✅ Complete	2024-12-11 View Docs
/account_trans?account_name=<>&email=<>	✅ Complete	2024-12-11 View Docs

---

📮 Postman API Testing

To explore and test the API endpoints, you can check out the Postman API documentation here (localhost version).

---

⚡ Quick Start

🔥 Clone the project

git clone https://github.com/FinTrak-Solutions/Backend.git

---

📦 Install Virtual Environment

cd Backend
virtualenv venv
source venv/bin/activate
pip3 install mkdocs

---

📁 Go to the Documentation Directory

cd Documentation

---

📝 Modify .md files in docs/

# Check and update locally
mkdocs serve
# Modify .md files in the docs/ folder

---

🚀 Build and Deploy

# Build and deploy
mkdocs build
mkdocs gh-deploy

---

Create new database using PostgreSQL

psql -U postgres

# PostgreSQL prompt
CREATE DATABASE financial_tracker_db;
# Verify
\l 
# Exit
\q