Skip to content
Snippets Groups Projects
Commit ce02c6bd authored by Obeng, Sinead (UG - Comp Sci & Elec Eng)'s avatar Obeng, Sinead (UG - Comp Sci & Elec Eng)
Browse files

Merge branch 'update-readme' into 'main'

Update readme

See merge request !21
parents 3bec4bb5 b30a0062
No related branches found
No related tags found
1 merge request!21Update readme
# Personal Finance Tracker # 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 ## Technology Stack
| Layer | Technology |
| Layer | Technology | | ----------- | ----------------------------------------------------------- |
|--------------|-----------------------------| | Frontend | React.js |
| Frontend | React.js | | Backend | Flask (Microservices: User, Transaction, Budget, Analytics) |
| Backend | Node.js / Express (TBC) | | API Gateway | Flask-based Reverse Proxy |
| Database | PostgreSQL | | Database | PostgreSQL (per microservice) |
| API Auth | JWT | | Auth | JWT (Flask-JWT-Extended) |
| Dev Tools | Docker, GitLab, Git | | Dev Tools | Docker, GitLab, Postman |
| CI/CD | GitLab CI (Planned) | | 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: (Requires Docker + Docker Compose installed.)
1. [Docker Compose](#🚀-run-using-docker)
2. [Local Setup](#💻-run-locally-without-docker)
--- `docker-compose up --build`
### 💻 Run Locally (Without Docker)
> 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
--- ---
## Core Features
#### Frontend Setup 1. Secure user registration & login (JWT)
2. Income & expense tracking
```bash 3. Budget management per category
git clone https://gitlab.surrey.ac.uk/so00624/personal-finance-tracker.git 4. Real-time financial dashboard
cd personal-finance-tracker/frontend 5. Analytics (daily, weekly, monthly, yearly)
npm install 6. Dockerized microservices with isolated databases
npm start
--- ---
## Testing
#### Backend Setup (Coming Soon) 1. Backend tested with Postman (JWT, validation, endpoints)
Instructions for backend will be added once implemented. 2. Frontend manually tested via browser
3. Docker health checks for all services
#### 🚀 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
--- ---
## Contributors
📸 Screenshots (Coming Soon) | Name | Contribution Summary |
<!-- Optional: Add screenshots of the running app --> <! | ------------------- | --------------------------------------------------------------------------- |
| 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) |
🙌 Contributors | Amzat Karim | Notification Service (planned) |
Sinead Obeng – User Registration & Authentication etccc | Juwon Atiku | Profile Page |
Ebehitale Oaahimijie – README + Feature Implementation etcc
Chiugo Bede-Alugbue
Amzat Karim
Juwon Atiku
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment