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
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 |
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