Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# developers
# Dynamic Family Budget Planner

This is the remote repository for the academy devs (students)
A single-page budgeting and cashflow planning prototype built with Tailwind CSS and vanilla JavaScript. Configure income sources, map bills to specific paychecks, plan aggressive debt payoff, and review a running cashflow ledger for the month.

# Jesse testing this out
## Features
- Income source manager to add, rename, or remove semi-monthly and bi-weekly pay schedules, each with configurable amounts and pay dates.
- Bill management workflow that lets you edit amounts, due days, assignment strategies, and aggressive payoff settings.
- Manual ledger transactions and savings allocations that flow into a combined payment calendar and paycheck summaries.
- Cashflow ledger that starts from your current buffer and tracks deposits, allocations, and expenses chronologically.

## Getting started
1. Clone the repository.
2. From the repository root run a simple static server, for example:
- macOS/Linux: `python3 -m http.server 8000`
- Windows: `py -m http.server 8000`
3. Visit `http://localhost:8000/index.html` in your browser to interact with the planner.
4. Use the **Income Sources** manager to rename existing jobs or add new ones with the correct pay frequency, then tweak bill assignments and transactions to fit your scenario.

Because everything is static files, you can also host the repository with GitHub Pages. Point Pages to the `main` branch and browse to `https://<your-username>.github.io/budget-planner/` once it publishes.

## Project structure
- `index.html` – layout, Tailwind configuration, and root markup for the planner UI.
- `app.js` – budgeting logic, payday calculations, bill assignment rules, and rendering helpers.
- `styles.css` – shared utility styles layered on top of Tailwind.
Loading