💸 Canine Club Invoicing System 💸

A mobile-first web application I built for my wife's dog-walking business. Built with Go and HTMX

🚀 Deploying

To run the app in a docker container, you'll need to create a .env file in the root directory with the following environment variables:

DATABASE_URL=postgres://user:password@host:5432/dbname?sslmode=disable
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USER=john@example.com
SMTP_PASS=P@ssw0rd
FROM_NAME=John Doe
FROM_ADDRESS=4 Privet Drive, Little Whinging, Surrey
FROM_CITY=London
ACCOUNT_NUMBER=12-3456-7890123-45
BASE_URL=http://invoices.example.com

I recommend using a docker-compose file to run the app. Here's an example:

services:
    db:
        image: postgres:18-alpine
        restart: unless-stopped
        environment:
            POSTGRES_USER: ccinvoice
            POSTGRES_PASSWORD: ccinvoice
            POSTGRES_DB: ccinvoice
        volumes:
            - postgres_data:/var/lib/postgresql/data
        healthcheck:
            test: ["CMD-SHELL", "pg_isready -U ccinvoice"]
            interval: 10s
            timeout: 5s
            retries: 5

    app:
        image: ghcr.io/scottmckendry/ccinvoice:main
        container_name: invoices
        depends_on:
            db:
                condition: service_healthy
        env_file:
            - .env
        environment:
            DATABASE_URL: postgres://ccinvoice:ccinvoice@db:5432/ccinvoice?sslmode=disable
        ports:
            - 3000:3000
        restart: unless-stopped

volumes:
    postgres_data:

This will run the app on port 3000 with a PostgreSQL database. The database data will be persisted in a Docker volume. I recommend using Traefik as a reverse proxy. Take a look at my setup guide for more information.

Warning

Do not expose the app to the internet without a reverse proxy running authentication middleware. The app does not have any authentication built in.

🧑‍💻 Development

To run the app locally, create a .env file matching the example above. Then use the docker-compose file in the root of the repository by running docker compose up. This will run the app on port 3000. You can then access the app at http://localhost:3000.

The project uses air for live reloading. To run the app locally without docker, run air in the root of the repository.

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.