A possible backend implementation for the Budget apps on Android & iOS

Find a file

Renovate Bot dcdd7831f2 Some checks failed Pull request workflow / Build and Test (pull_request) Failing after 4m1s Details Update ktor to v3		2024-10-10 11:08:44 +00:00
.forgejo/workflows	Update docker/metadata-action action to v5	2024-07-07 08:01:55 +00:00
.github/workflows	Update gradle/wrapper-validation-action action to v3	2024-07-07 10:01:54 +00:00
api	Fix kotlinx serialization not being applied	2024-04-20 22:06:44 -06:00
app	Add XForwardedHeaders plugin	2024-04-21 10:05:43 -06:00
core	Add mustache support with static assets and functional login/registration	2024-04-20 22:06:44 -06:00
db	Finish implementing remaining service classes	2024-03-27 16:59:18 -06:00
gradle	Update ktor to v3	2024-10-10 11:08:44 +00:00
service	Add some budget pages	2024-04-20 22:06:44 -06:00
storage	Finish implementing remaining service classes	2024-03-27 16:59:18 -06:00
testhelpers	Finish implementing remaining service classes	2024-03-27 16:59:18 -06:00
web	Fix some styling issues for forms	2024-07-07 10:54:49 -06:00
.gitignore	Add support for sqlite	2023-08-07 20:42:01 -06:00
build.gradle.kts	Fix kotlinx serialization not being applied	2024-04-20 22:06:44 -06:00
COPYING	Switch to AGPLv3	2024-03-09 16:34:20 +00:00
docker-compose.yml	Update postgres Docker tag to v17	2024-09-27 03:08:25 +00:00
Dockerfile	Switch to ibm-semeru for docker images	2024-07-07 10:22:57 -06:00
gradlew	Update dependency gradle to v8.9	2024-07-11 15:06:43 +00:00
gradlew.bat	Update dependency gradle to v8.9	2024-07-11 15:06:43 +00:00
LICENSE	Switch to AGPLv3	2024-03-09 16:34:20 +00:00
README.md	Update README	2024-04-20 22:06:44 -06:00
renovate.json	Add renovate.json	2024-07-07 02:50:10 +00:00
settings.gradle.kts	WIP: Move API logic to shared services	2024-03-27 16:59:18 -06:00

README.md

Twigs

Twigs is a personal finance application tailored to individuals and small groups that want robust budgeting features without needing to pay a monthly subscription.

Prerequisites

JDK 17 or newer
PostgreSQL 13 or newer
(optional) Docker

Running

Prior to running the app, make sure you have a PostgreSQL server running, with a database and user ready to go. To avoid the hassle of figuring out how to get it installed locally, using Docker is recommended, and a sample docker-compose.yml file is included in the root of the repository. If you already have a PostgreSQL server running, you can run the app from the command line with gradle:

./gradlew run

Configuration

Some parameters of Twigs can be configured via environment variables:

Environment Variable	Default Value	Note
`TWIGS_PORT`	`8080`	Port for web server to listen on
`TWIGS_DB_HOST`	`localhost`	PostgreSQL server host
`TWIGS_DB_PORT`	`5432`	PostgreSQL server port
`TWIGS_DB_NAME`	`twigs`	PostgreSQL database name
`TWIGS_DB_USER`	`twigs`	PostgreSQL database user
`TWIGS_DB_PASS`	`twigs`	PostgreSQL database password
`TWIGS_PW_SALT`		Salt to use for password, generated if empty or null
`TWIGS_SMTP_FROM`		From email address for automated emails sent from Twigs
`TWIGS_SMTP_HOST`		SMTP server host for sending emails
`TWIGS_SMTP_PORT`		SMTP server port for sending emails
`TWIGS_SMTP_USER`		SMTP server username for sending emails
`TWIGS_SMTP_PASS`		SMTP server password for sending emails

Building

Building the app is also handled with gradle:

./gradlew shadowJar

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.