Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bernardoamorim7/piggy-planner
A self hostable and easy to use finance tracker.
https://github.com/bernardoamorim7/piggy-planner
a-h-templ alpinejs chartjs daisyui docker echo-framework finance finance-management go golang self-hosted sqlite tailwindcss
Last synced: 9 days ago
JSON representation
A self hostable and easy to use finance tracker.
- Host: GitHub
- URL: https://github.com/bernardoamorim7/piggy-planner
- Owner: bernardoamorim7
- License: mit
- Created: 2024-05-26T16:02:02.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-20T19:20:47.000Z (about 1 month ago)
- Last Synced: 2024-10-22T01:09:44.209Z (29 days ago)
- Topics: a-h-templ, alpinejs, chartjs, daisyui, docker, echo-framework, finance, finance-management, go, golang, self-hosted, sqlite, tailwindcss
- Language: Go
- Homepage:
- Size: 5.79 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Piggy Planner
The self hosted and easy to use finance tracker.
Piggy Planner is a simple budgeting application that allows users to track their expenses and income. The application is built using Go, Templ, HTMX, AlpineJS, Chart.js, SQLite and DaisyUI with TailwindCSS.
## Usage
Just download the latest release and run the executable.
The application will start a web server on `localhost:8777` unless you specify a different address using an environment variable called `PIGGY_PORT`.
The application will create a SQLite database in the current working directory called `piggy_planner.db`.
## Building from Source
To build the application from source, you will need:
- Go 1.22 or later
- Node.js 20 or later
- Templ
First, clone the repository:
```bash
git clone "https://github.com/bernardoamorim7/piggy-planner.git"
```
Install the required Node.js packages:
```bash
npm install
```
Install templ using the following command:
```bash
go install github.com/a-h/templ/cmd/templ@latest
```
Now you can either use the Makefile
```bash
make build
```
or build the application manually, generating the templ files, the CSS file and building the Go application:
```bash
templ generate && npx tailwindcss -i ./web/assets/css/input.css -o ./web/assets/css/tailwind.css --minify && go build -o piggy-planner main.go
```
## Contributing
Pull requests are welcome, but this project is a personal project and I may not have the time to review and merge them.
If you find a bug or have a feature request, please open an issue.
## License
This project is licensed under the [MIT License](LICENSE).