Dominion/README.md

48 lines
2.2 KiB
Markdown
Raw Normal View History

2026-08-07 09:48:18 +00:00
# Commercial Banking Balance Sheet & Financial Reporting Portal
2026-08-07 08:06:39 +00:00
2026-08-07 09:48:18 +00:00
A full-stack enterprise web application built for multi-branch balance sheet consolidation, trial balance ledger verification, automated accounting reconciliation, double-entry bookkeeping, and executive financial reporting.
2026-08-07 08:06:39 +00:00
2026-08-07 09:48:18 +00:00
---
2026-08-07 08:06:39 +00:00
2026-08-07 09:48:18 +00:00
## 🚀 Key Features
2026-08-07 08:06:39 +00:00
2026-08-07 09:48:18 +00:00
- **Multi-Branch Operations**: Head Office Admin, Branch Users, Maker-Checker authorization matrix.
- **Server-Side Architecture**: Express backend (`server.ts`) handling state management, calculations, audit logging, and email dispatches.
- **PostgreSQL & Fallback Storage**: Connects to PostgreSQL via `pg` connection pool with automatic fallback to JSON data persistence (`/app/data/portal-data.json`).
2026-08-07 16:19:17 +00:00
- **Containerized Deployment**: Built for Docker, Docker Compose, and **Coolify** self-hosting.
2026-08-07 08:06:39 +00:00
2026-08-07 09:48:18 +00:00
---
2026-08-07 08:06:39 +00:00
2026-08-07 09:48:18 +00:00
## 📁 Repository Structure & Key Configuration Files
2026-08-07 08:06:39 +00:00
2026-08-07 09:48:18 +00:00
| File | Description |
| :--- | :--- |
2026-08-07 16:19:17 +00:00
| `Dockerfile` & `dockerfile` | Multi-stage production container build (Vite client + Express CJS server, exposing port 3000 with IPv4 health check). |
| `docker-compose.yml` | Full-stack orchestration (App container on port 3000 + PostgreSQL container on port 5432). |
| `.dockerignore` | Context exclusions for slim Docker image builds. |
2026-08-07 13:58:55 +00:00
| `.env.example` | Template environment variables (`DATABASE_URL`, `PORT`, `DATA_PATH`, `SMTP_*`). |
2026-08-07 16:19:17 +00:00
| `COOLIFY.md` | Deployment & "No Available Server" troubleshooting guide for Coolify platform & Traefik proxies. |
2026-08-07 10:35:45 +00:00
| `server.ts` | Express server entry point with PostgreSQL initialization, environment SMTP dispatching, and REST API routes. |
2026-08-07 09:48:18 +00:00
---
## 🛠️ Local Development & Running via Docker
2026-08-07 16:19:17 +00:00
### 1. Run via Docker Compose
2026-08-07 09:48:18 +00:00
```bash
docker-compose up --build -d
```
2026-08-07 16:19:17 +00:00
The application container exposes port `3000` (`http://localhost:3000`), with an automated health check on `/api/health`.
2026-08-07 09:48:18 +00:00
### 2. Run via Docker CLI
```bash
docker build -t balance-sheet-portal .
2026-08-07 13:58:55 +00:00
docker run -p 3000:3000 -v portal_data:/app/data balance-sheet-portal
2026-08-07 09:48:18 +00:00
```
---
## ☁️ Deployment on Coolify
2026-08-07 16:19:17 +00:00
Refer to [`COOLIFY.md`](./COOLIFY.md) for step-by-step instructions on deploying via Docker Compose or Coolify Managed PostgreSQL, and resolving Traefik "No available server" status.