expenseowl
v1.0.0
Published
Expense management API server
Downloads
5
Readme
📊 ExpenseOwl Credit Card Fork
This is a fork of ExpenseOwl in TypeScript tailored to support credit card-style expense tracking with mock data population, Docker deployment, and local development support.
🧑💻 Local Development
Run the app locally with hot-reloading:
npm run devThis uses tsx in watch mode to serve the project. Expenses are hardcoded for UI testing and stored in data/expenses.json.
🐳 Docker
Build & Run with Mock Data
npm run dockerSteps performed:
- Stops and removes any running container.
- Builds the Docker image (
expenseowl-custom). - Runs the container on port
8080. - Executes
mock-data-populate.shto seedexpenses.jsonin the Docker environment.
Publish to Docker Hub
npm run publishSteps performed:
- Rebuilds the Docker image.
- Tags the image as
yzpaul/expenseowl-creditcard:latest. - Pushes to Docker Hub.
📂 Scripts
scripts/restart.sh
Used for local testing USING DOCKER and demo data population.
scripts/docker-deploy.sh
Used for building and publishing the Docker image.
✅ Project Status
This is a TypeScript fork of ExpenseOwl with a focus on credit-card statement imports (transaction are assumed to be negative as opposed to bank account imports in the original where a transaction is positive)
