183 lines
6.4 KiB
Markdown
183 lines
6.4 KiB
Markdown
<p align="center">
|
|
<img src="https://whisper.money/images/og_whisper_money.png?20260215075346" alt="Whisper Money" width="100%">
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://zdoc.app/de/whisper-money/whisper-money">Deutsch</a> |
|
|
<a href="https://zdoc.app/es/whisper-money/whisper-money">Español</a> |
|
|
<a href="https://zdoc.app/fr/whisper-money/whisper-money">français</a> |
|
|
<a href="https://zdoc.app/ja/whisper-money/whisper-money">日本語</a> |
|
|
<a href="https://zdoc.app/ko/whisper-money/whisper-money">한국어</a> |
|
|
<a href="https://zdoc.app/pt/whisper-money/whisper-money">Português</a> |
|
|
<a href="https://zdoc.app/ru/whisper-money/whisper-money">Русский</a> |
|
|
<a href="https://zdoc.app/zh/whisper-money/whisper-money">中文</a>
|
|
</p>
|
|
|
|
# Whisper Money
|
|
|
|
<img src="https://github.com/whisper-money/whisper-money/actions/workflows/ci.yml/badge.svg" /> [![CC BY-NC 4.0][cc-by-nc-shield]][cc-by-nc]
|
|
|
|
**The most secure way to understand your finances.**
|
|
|
|
Whisper Money is a privacy-first personal finance application that helps you track, categorize, and understand your spending—all while keeping your financial data encrypted and secure.
|
|
|
|
> 🎮 **Try the Demo:** Experience Whisper Money with our [demo account](https://whisper.money/login?demo=1) - no registration required!
|
|
|
|
> 💬 **Join our Community:** Whether you're a user looking for help or a developer wanting to contribute, we'd love to have you in our [Discord server](https://discord.gg/m8hUhx6D9D)! Share feedback, ask questions, discuss new features, or just hang out with fellow privacy enthusiasts.
|
|
|
|
## Features
|
|
|
|
- 🔐 **Privacy-first** — Your data is never shared with third parties. You own it
|
|
- 🏦 **Bank account management** — Track multiple accounts in one place
|
|
- 📊 **Transaction categorization** — Automatic and manual categorization
|
|
- 🤖 **Automation rules** — Set up rules to auto-categorize transactions
|
|
- 📈 **Financial insights** — Understand your spending patterns
|
|
|
|
## Tech Stack
|
|
|
|
- **Backend:** Laravel 12, PHP 8.4
|
|
- **Frontend:** React 19, Inertia.js v2, TypeScript
|
|
- **Styling:** Tailwind CSS v4
|
|
- **Database:** MySQL
|
|
- **Cache/Queue:** Redis
|
|
- **Testing:** Pest v4
|
|
|
|
## Running Locally
|
|
|
|
### Quick Start (Recommended)
|
|
|
|
The easiest way to get started is using our automated setup script:
|
|
|
|
```bash
|
|
bash <(curl -fsSL https://whisper.money/setup.sh)
|
|
```
|
|
|
|
After installation, just visit **<https://whisper.money.localhost>** in your browser.
|
|
|
|
### Manual Setup
|
|
|
|
If you prefer to set up manually:
|
|
|
|
1. **Clone the repository:**
|
|
|
|
```bash
|
|
git clone https://github.com/whisper-money/whisper-money.git
|
|
cd whisper-money
|
|
```
|
|
|
|
1. **Run the setup script:**
|
|
|
|
```bash
|
|
whispermoney install
|
|
```
|
|
|
|
### Available Commands
|
|
|
|
> **Important:** You must run `whispermoney install` before using any other command. If you skip the install step, commands like `start` will not work.
|
|
|
|
Once installed, you can use the `whispermoney` command for common tasks:
|
|
|
|
```bash
|
|
# Start all services
|
|
whispermoney start
|
|
|
|
# Stop all services
|
|
whispermoney stop
|
|
|
|
# Upgrade to latest version
|
|
whispermoney upgrade
|
|
|
|
# Interactive menu
|
|
whispermoney
|
|
```
|
|
|
|
### Development Server
|
|
|
|
For active development with hot reloading:
|
|
|
|
```bash
|
|
composer run dev
|
|
```
|
|
|
|
This will concurrently start:
|
|
|
|
- PHP development server (via [Portless](https://portless.sh) HTTPS proxy)
|
|
- Queue worker
|
|
- Log viewer (Pail)
|
|
- Vite dev server
|
|
|
|
The application will be available at **<https://dev.whisper.money.localhost>**. In git worktrees, the branch name is automatically prepended (e.g. `https://fix-ui.dev.whisper.money.localhost`).
|
|
|
|
## Running with Docker (Production Image)
|
|
|
|
For testing the production Docker image locally:
|
|
|
|
1. **Copy the production environment file:**
|
|
|
|
```bash
|
|
cp .env.production.example .env
|
|
```
|
|
|
|
1. **Start the services:**
|
|
|
|
```bash
|
|
docker compose -f docker-compose.production.yml up -d
|
|
```
|
|
|
|
The application will be available at `http://localhost:8080`.
|
|
|
|
To use a different port, set `APP_PORT`:
|
|
|
|
```bash
|
|
APP_PORT=3000 docker compose -f docker-compose.production.yml up -d
|
|
```
|
|
|
|
## Deploying to Coolify
|
|
|
|
Whisper Money can be easily deployed to [Coolify](https://coolify.io) using our Docker Compose template.
|
|
|
|
### Quick Deploy
|
|
|
|
1. In Coolify, create a new resource and select **Docker Compose**
|
|
2. Choose **Empty Compose File** as the source
|
|
3. Paste the contents from our template:
|
|
👉 **[whisper-money.yaml](https://raw.githubusercontent.com/whisper-money/whisper-money/main/templates/coolify/whisper-money.yaml)**
|
|
4. Deploy!
|
|
|
|
The template includes:
|
|
|
|
- Whisper Money application container
|
|
- MySQL 8.0 database with health checks
|
|
- Persistent volumes for data and storage
|
|
- Auto-generated database credentials
|
|
|
|
### Required Environment Variables
|
|
|
|
| Variable | Description |
|
|
| ---------------- | ---------------------------------------------------------- |
|
|
| `RESEND_API_KEY` | Email service API key (for password resets, notifications) |
|
|
|
|
> **Note**: `APP_KEY` and `APP_URL` are auto-configured. The container generates an `APP_KEY` on first startup if not provided.
|
|
|
|
### Optional Environment Variables
|
|
|
|
| Variable | Default | Description |
|
|
| ----------------------- | ------- | -------------------------------------------------- |
|
|
| `DRIP_EMAILS_ENABLED` | `true` | Enable drip emails (welcome, onboarding, feedback) |
|
|
| `HIDE_AUTH_BUTTONS` | `false` | Hide login/register buttons on landing page |
|
|
| `SUBSCRIPTIONS_ENABLED` | `false` | Enable Stripe subscriptions |
|
|
| `STRIPE_KEY` | - | Stripe publishable key |
|
|
| `STRIPE_SECRET` | - | Stripe secret key |
|
|
| `STRIPE_WEBHOOK_SECRET` | - | Stripe webhook signing secret |
|
|
|
|
## Star History
|
|
|
|
[](https://www.star-history.com/?type=date&legend=top-left&repos=whisper-money%2Fwhisper-money)
|
|
|
|
## License
|
|
|
|
This work is licensed under a
|
|
[Creative Commons Attribution-NonCommercial 4.0 International License][cc-by-nc].
|
|
|
|
[cc-by-nc]: https://creativecommons.org/licenses/by-nc/4.0/
|
|
[cc-by-nc-shield]: https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg
|