Skip to content

Commit e581467

Browse files
committed
adding paychecks
1 parent d5c2869 commit e581467

36 files changed

Lines changed: 5504 additions & 218 deletions

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,4 +263,7 @@ app/config.py
263263

264264
Pipfile.lock
265265
database.erd
266-
uploads/*
266+
uploads/*
267+
data/monarch-categories.json
268+
data/monarch-categories-data.csv
269+
data/transactions-196135697039987462-196135697026283140-eaf6170e-7fed-4d55-8759-c0659c1af537.csv

README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A comprehensive personal finance management system built with Flask, featuring t
44

55
---
66

7-
## 🚀 Quick Start
7+
## Quick Start
88

99
### Prerequisites
1010
- Python 3.13+
@@ -31,35 +31,35 @@ The application will be available at: http://localhost:5000
3131

3232
---
3333

34-
## Features
34+
## Features
3535

3636
### Core Functionality
37-
- **User Authentication** - Signup, login, session management
38-
- **Institutions** - Track financial institutions
39-
- **Accounts** - Manage checking, savings, credit cards, loans, etc.
40-
- **Categories** - Three-level hierarchy (Type → Group → Category)
41-
- **Transactions** - Full transaction tracking with pagination
37+
- **User Authentication** - Signup, login, session management
38+
- **Institutions** - Track financial institutions
39+
- **Accounts** - Manage checking, savings, credit cards, loans, etc.
40+
- **Categories** - Three-level hierarchy (Type → Group → Category)
41+
- **Transactions** - Full transaction tracking with pagination
4242

4343
### Import Features
44-
- **Categories CSV Import** - Bulk import categories with auto-creation of types and groups
45-
- **Transactions CSV Import** - Import transactions with smart account creation
44+
- **Categories CSV Import** - Bulk import categories with auto-creation of types and groups
45+
- **Transactions CSV Import** - Import transactions with smart account creation
4646

4747
### API Features
48-
- **RESTful API** - Complete REST API with Flask-RESTX
49-
- **Swagger Documentation** - Auto-generated API docs at `/api/doc/`
50-
- **Input Validation** - Comprehensive validation preventing crashes
51-
- **Error Handling** - Proper error codes and messages
48+
- **RESTful API** - Complete REST API with Flask-RESTX
49+
- **Swagger Documentation** - Auto-generated API docs at `/api/doc/`
50+
- **Input Validation** - Comprehensive validation preventing crashes
51+
- **Error Handling** - Proper error codes and messages
5252

5353
---
5454

55-
## 📊 Test Coverage
55+
## Test Coverage
5656

5757
**Current Status:** 121 out of 142 tests passing (85.2%)
5858

5959
| Category | Tests | Passed | Pass Rate |
6060
|----------|-------|--------|-----------|
61-
| Models | 63 | 63 | **100%** |
62-
| API Endpoints | 56 | 54 | **96%** |
61+
| Models | 63 | 63 | **100%** |
62+
| API Endpoints | 56 | 54 | **96%** |
6363
| Web Controllers | 23 | 4 | 17% |
6464

6565
### Running Tests
@@ -78,7 +78,7 @@ pytest --cov=api --cov=app --cov-report=html
7878

7979
---
8080

81-
## 📚 Documentation
81+
## Documentation
8282

8383
**Complete documentation is available in the [/docs](docs/) directory.**
8484

@@ -98,7 +98,7 @@ pytest --cov=api --cov=app --cov-report=html
9898

9999
---
100100

101-
## 🎯 Key Features
101+
## Key Features
102102

103103
### Categories Import
104104

@@ -125,7 +125,7 @@ Date,Merchant,Category,Account,Original Statement,Notes,Amount,Tags
125125

126126
---
127127

128-
## 🗂️ Project Structure
128+
## Project Structure
129129

130130
```
131131
OSPF/
@@ -163,7 +163,7 @@ OSPF/
163163

164164
---
165165

166-
## 🔧 Configuration
166+
## Configuration
167167

168168
Configuration is in `app/config.py`:
169169

@@ -207,7 +207,7 @@ class Config(object):
207207

208208
---
209209

210-
## 🛠️ Technologies Used
210+
## Technologies Used
211211

212212
### Backend
213213
- **Flask** - Web framework
@@ -230,20 +230,20 @@ class Config(object):
230230

231231
---
232232

233-
## 📈 Recent Updates
233+
## Recent Updates
234234

235235
### October 26, 2025
236-
- Created comprehensive test suite (142 tests)
237-
- Fixed test issues (improved from 62% to 85% pass rate)
238-
- Added input validation to 5 API controllers
239-
- Implemented categories CSV import feature
240-
- Implemented transactions CSV import feature
241-
- Organized documentation into /docs directory
242-
- Fixed account creation frontend issue
236+
- Created comprehensive test suite (142 tests)
237+
- Fixed test issues (improved from 62% to 85% pass rate)
238+
- Added input validation to 5 API controllers
239+
- Implemented categories CSV import feature
240+
- Implemented transactions CSV import feature
241+
- Organized documentation into /docs directory
242+
- Fixed account creation frontend issue
243243

244244
---
245245

246-
## 🎓 Getting Started Guide
246+
## Getting Started Guide
247247

248248
### 1. First Time Setup
249249

@@ -284,7 +284,7 @@ python main.py
284284

285285
---
286286

287-
## 🐛 Known Issues
287+
## Known Issues
288288

289289
### Test Suite
290290
- 21 tests currently failing (15% failure rate)
@@ -296,7 +296,7 @@ See [Final Fix Results](docs/FINAL_FIX_RESULTS.md) for details and fixes.
296296

297297
---
298298

299-
## 🤝 Contributing
299+
## Contributing
300300

301301
### Running Tests Before Committing
302302

@@ -319,13 +319,13 @@ pytest --cov=api --cov=app --cov-report=term-missing
319319

320320
---
321321

322-
## 📝 License
322+
## License
323323

324324
This project is for personal use.
325325

326326
---
327327

328-
## 📞 Support
328+
## Support
329329

330330
### Documentation
331331
- [Complete Documentation Index](docs/INDEX.md)
@@ -340,11 +340,11 @@ This project is for personal use.
340340

341341
---
342342

343-
## 🎉 Status
343+
## Status
344344

345345
**Current Version:** 1.0
346346
**Test Coverage:** 85.2% (121/142 tests passing)
347-
**Production Status:** Ready for use
347+
**Production Status:** Ready for use
348348
**Last Updated:** October 26, 2025
349349

350350
---

0 commit comments

Comments
 (0)