41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
# Finance-Accounts
|
||
|
||
Finance team tooling for **Utopia Brands**. The main (currently only) application is the
|
||
**Amazon Accounts Receivable Aging Dashboard** — it turns the month's Amazon *Custom
|
||
Unified Transaction* exports into the month-end AR workbook, with per-user login
|
||
(self-service password reset by emailed code), month-end controls, central-bank
|
||
exchange-rate fetching, and a full audit trail.
|
||
|
||
## Repository layout
|
||
|
||
```
|
||
ar-aging-app/ The application (FastAPI backend · React frontend)
|
||
│
|
||
├── backend/ Python API + calculation engine + tests
|
||
├── frontend/ React + TypeScript dashboard
|
||
├── scripts/ Launchers: start.ps1 / start.bat (Windows) · start.command (macOS)
|
||
├── deploy/ Production runbook (DEPLOY.md) + backup script
|
||
├── docs/ System guide, AR logic, audit reports
|
||
├── docker-compose.yml local Docker stack (dev)
|
||
├── docker-compose.prod.yml production stack (AWS: HTTPS + MySQL + backups)
|
||
└── .env.example every setting, local + production sections
|
||
|
||
plan.md Production-readiness plan (architecture, AWS costs, phases)
|
||
sample data (local) "Test Files/" — real Amazon exports; gitignored, never committed
|
||
```
|
||
|
||
## Quick start
|
||
|
||
| I want to… | Do this |
|
||
|---|---|
|
||
| Run the app on this PC | double-click `ar-aging-app/scripts/start.bat` → http://localhost:5174 |
|
||
| Understand the app | [ar-aging-app/README.md](ar-aging-app/README.md) |
|
||
| Deploy to AWS | [ar-aging-app/deploy/DEPLOY.md](ar-aging-app/deploy/DEPLOY.md) (~$50–55/month) |
|
||
| See how figures are calculated | [ar-aging-app/docs/system-guide.md](ar-aging-app/docs/system-guide.md) |
|
||
| Read the production plan | [plan.md](plan.md) |
|
||
| Reset a forgotten password | login screen → "Forgot password?" (emailed code) — or admin: `manage.py set-password` |
|
||
| Manage users / fix data | `python ar-aging-app/backend/manage.py --help` |
|
||
|
||
Financial data never enters git: spreadsheets, databases, uploads, and `.env*` secrets are
|
||
all ignored (see `.gitignore`). The only template committed is `ar-aging-app/.env.example`.
|