https://github.com/scottmckendry/ccinvoice

A mobile-first invoice generation system for Canine Club - a dog walking business 🐕
https://github.com/scottmckendry/ccinvoice

fiber go golang htmx

Last synced: about 2 months ago
JSON representation

A mobile-first invoice generation system for Canine Club - a dog walking business 🐕

• Host: GitHub
• URL: https://github.com/scottmckendry/ccinvoice
• Owner: scottmckendry
• License: mit
• Created: 2023-11-01T06:13:39.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-02T22:20:24.000Z (10 months ago)
• Last Synced: 2024-12-10T17:17:49.583Z (10 months ago)
• Topics: fiber, go, golang, htmx
• Language: Go
• Homepage:
• Size: 580 KB
• Stars: 48
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
💸 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:

```env

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:

```yaml

version: "3"

services:

    invoices:

        image: ghcr.io/scottmckendry/ccinvoice:main

        container_name: invoices

        networks:

            - traefik

        volumes:

            - /etc/localtime:/etc/localtime:ro

            - /var/run/docker.sock:/var/run/docker.sock

            - ./data/:/app/data/

            - ./.env:/app/.env

        ports: 3000:3000

        restart: unless-stopped

```

This will run the app on port 3000. I recommend using [Traefik](https://traefik.io) as a reverse proxy. Take a look at my [setup guide](https://scottmckendry.tech/traefik-setup/) 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](http://localhost:3000).

The project uses [air](https://github.com/cosmtrek/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.