Skip to content

Latest commit

 

History

History
131 lines (98 loc) · 4.56 KB

README.md

File metadata and controls

131 lines (98 loc) · 4.56 KB
Raw

Hisabi is a simple yet powerful, self-hosted personal finance tracking web app with the ability to parse SMS transactions and generate very useful insights about your money. It's also powered by ChatGPT!

💰 Sponsors

Support this project by becoming a sponsor ❤️. Your logo will show up here with a link to your website. Become a sponsor

Follow me on LinkedIn for updates and latest news.

🛠 Features

Self hosted SMS parser HisabiGPT
Reporting API Mobile app

Warning

The mobile app is still under development and not yet released. Please check the source code for more information.

🎮 Demo

Try the app with live demo.

▶️ Installation

Docker Installation

  1. Method one (recommended)
git clone https://github.com/hisabi-app/hisabi && cd hisabi

make build # build the docker image
make run # the same as docker-compose up -d

# wait for a few seconds to allow the DB to finish the setup then run
make install # only for the first time
2. Method two (using docker-compose public hosted docker image)

First, create a docker-compose.yml file

version: '3'
services:
    app:
        image: 'salee2m1/hisabi:2.0.1'
        ports:
            - "80:80"
        networks:
            - hisabi
        depends_on:
            - mysql
        environment:
            OPENAI_API_KEY: 'YOUR_OPENAI_API_KEY'
    mysql:
        image: 'mysql/mysql-server:8.0'
        ports:
            - '3306:3306'
        environment:
            MYSQL_ROOT_PASSWORD: 'root'
            MYSQL_ROOT_HOST: "%"
            MYSQL_DATABASE: 'hisabi'
            MYSQL_USER: 'hisabi'
            MYSQL_PASSWORD: 'hisabi'
            MYSQL_ALLOW_EMPTY_PASSWORD: 1
        volumes:
            - 'hisabimysql:/var/lib/mysql'
        networks:
            - hisabi
        healthcheck:
            test: ["CMD", "mysqladmin", "ping", "-proot"]
            retries: 3
            timeout: 5s
networks:
    hisabi:
        driver: bridge
volumes:
    hisabimysql:
        driver: local

Then, inside the same directory run

docker-compose up -d
# wait for a few seconds to run the DB then run
docker-compose run app php artisan migrate
docker-compose run app php artisan hisabi:install

Once done, visit the app on https://localhost

Read full documentation

JetBrains Sponsorship

Thank you, JetBrains for sponsoring the license ❤️

Get $200 DigitalOcean Credit

DigitalOcean Referral Badge

Project Visualization

Visualization of this repo

🪚 Built with

  1. Laravel
  2. Inertia & ReactJs
  3. GraphQL
  4. MySQL
  5. Docker

🔖 License

This project is licensed under the MIT License - see the LICENSE.md file for details.