From b30a00623e7dd8e4e5bb85d48c35f0122db324b0 Mon Sep 17 00:00:00 2001 From: "Obeng, Sinead (UG - Comp Sci & Elec Eng)" <so00624@surrey.ac.uk> Date: Tue, 20 May 2025 12:04:20 +0000 Subject: [PATCH] Update final README.md --- README.md | 89 ++++++++++++++++++++++++------------------------------- 1 file changed, 38 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 6ac23e9..504f775 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,53 @@ # Personal Finance Tracker -A web-based application that helps users track income, expenses, and financial trends over time. Designed with simplicity and scalability in mind, this app empowers users to gain better control over their personal finances. +A full-stack web application that empowers users to manage income, expenses, budgets, and financial goals through a clean, intuitive interface. Built using microservices for scalability and maintainability. --- -## 📦 Technology Stack - -| Layer | Technology | -|--------------|-----------------------------| -| Frontend | React.js | -| Backend | Node.js / Express (TBC) | -| Database | PostgreSQL | -| API Auth | JWT | -| Dev Tools | Docker, GitLab, Git | -| CI/CD | GitLab CI (Planned) | +## Technology Stack +| Layer | Technology | +| ----------- | ----------------------------------------------------------- | +| Frontend | React.js | +| Backend | Flask (Microservices: User, Transaction, Budget, Analytics) | +| API Gateway | Flask-based Reverse Proxy | +| Database | PostgreSQL (per microservice) | +| Auth | JWT (Flask-JWT-Extended) | +| Dev Tools | Docker, GitLab, Postman | +| CI/CD | GitLab CI (Planned) | --- -## ðŸ› ï¸ Installation Guide +## Installation Guide +You can run the app using Docker Compose -You can run the app in two ways: -1. [Docker Compose](#🚀-run-using-docker) -2. [Local Setup](#💻-run-locally-without-docker) +(Requires Docker + Docker Compose installed.) ---- -### 💻 Run Locally (Without Docker) +`docker-compose up --build` -> Make sure you have `Node.js` and `npm` installed. +This will: +Spin up all Flask microservices +Launch the React frontend +Connect services via Docker internal networking --- - -#### Frontend Setup - -```bash -git clone https://gitlab.surrey.ac.uk/so00624/personal-finance-tracker.git -cd personal-finance-tracker/frontend -npm install -npm start +## Core Features +1. Secure user registration & login (JWT) +2. Income & expense tracking +3. Budget management per category +4. Real-time financial dashboard +5. Analytics (daily, weekly, monthly, yearly) +6. Dockerized microservices with isolated databases --- - -#### Backend Setup (Coming Soon) -Instructions for backend will be added once implemented. - -#### 🚀 Run Using Docker -Requires Docker + Docker Compose installed. -```bash -docker-compose up --build - -##This will: -##Build and run the frontend -##Build and run the backend (once ready) -##Link services via Docker Compose +## Testing +1. Backend tested with Postman (JWT, validation, endpoints) +2. Frontend manually tested via browser +3. Docker health checks for all services --- - -📸 Screenshots (Coming Soon) -<!-- Optional: Add screenshots of the running app --> <! - ---- - -🙌 Contributors -Sinead Obeng – User Registration & Authentication etccc -Ebehitale Oaahimijie – README + Feature Implementation etcc -Chiugo Bede-Alugbue -Amzat Karim -Juwon Atiku \ No newline at end of file +## Contributors +| Name | Contribution Summary | +| ------------------- | --------------------------------------------------------------------------- | +| Sinead Obeng | User Auth, Expense, Dashboard & Budget pages, Testing, Architecture setup. | +| Ebehi Oahimijie | Transaction & Income pages, README Author, Dynamic Password UX | +| Chiugo Bede-Alugbue | Future Expense Calendar feature (planned) | +| Amzat Karim | Notification Service (planned) | +| Juwon Atiku | Profile Page | -- GitLab