wbrawner/twigs
1
0
Fork 0
Code Issues Pull requests 2 Projects Releases Packages 1 Wiki Activity Actions
A possible backend implementation for the Budget apps on Android & iOS
175 commits 19 branches 0 tags 4.6 MiB
Kotlin 88.7%
Mustache 8.5%
CSS 2%
HTML 0.4%
Dockerfile 0.3%
Find a file
dependabot[bot] d80d0273bc Bump kotlin from 1.9.10 to 1.9.23 
Bumps `kotlin` from 1.9.10 to 1.9.23.

Updates `org.jetbrains.kotlin:kotlin-gradle-plugin` from 1.9.10 to 1.9.23
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/v1.9.23/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v1.9.10...v1.9.23)

Updates `org.jetbrains.kotlin:kotlin-reflect` from 1.9.10 to 1.9.23
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/v1.9.23/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v1.9.10...v1.9.23)

Updates `org.jetbrains.kotlin:kotlin-test-junit` from 1.9.10 to 1.9.23
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/v1.9.23/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v1.9.10...v1.9.23)

Updates `org.jetbrains.kotlin.jvm` from 1.9.10 to 1.9.23
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/v1.9.23/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v1.9.10...v1.9.23)

Updates `org.jetbrains.kotlin.plugin.serialization` from 1.9.10 to 1.9.23
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/v1.9.23/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v1.9.10...v1.9.23)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlin:kotlin-gradle-plugin
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: org.jetbrains.kotlin:kotlin-reflect
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: org.jetbrains.kotlin:kotlin-test-junit
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: org.jetbrains.kotlin.jvm
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: org.jetbrains.kotlin.plugin.serialization
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-03-11 08:45:24 +00:00
.github Use rebase for auto merge workflow 2024-03-09 16:25:23 +00:00
api Fix failures in UserRouteTest 2024-03-09 09:03:30 -07:00
app Remove config file, just load data from env 2024-03-09 09:13:57 -07:00
core Add more tests for user routes 2024-03-09 09:03:30 -07:00
db Add tests for /api/budget routes 2023-09-26 20:04:55 -06:00
gradle Bump kotlin from 1.9.10 to 1.9.23 2024-03-11 08:45:24 +00:00
storage Add more tests for user routes 2024-03-09 09:03:30 -07:00
testhelpers Fix failures in UserRouteTest 2024-03-09 09:03:30 -07:00
web Update deprecated method calls in front end 2024-03-09 09:13:57 -07:00
.gitignore Add support for sqlite 2023-08-07 20:42:01 -06:00
build.gradle.kts Fix compilation 2024-03-09 09:03:30 -07:00
COPYING Switch to AGPLv3 2024-03-09 16:34:20 +00:00
docker-compose.yml WIP: Finish ktor migration 2021-08-12 15:22:06 -06:00
Dockerfile Add docker builds for arm 2022-05-18 18:35:15 -06:00
gradlew Migrate from JDK 8 -> 11 and use Gradle instead of Maven 2020-02-10 17:57:53 -07:00
gradlew.bat Migrate from JDK 8 -> 11 and use Gradle instead of Maven 2020-02-10 17:57:53 -07:00
LICENSE Switch to AGPLv3 2024-03-09 16:34:20 +00:00
README.md Switch to AGPLv3 2024-03-09 16:34:20 +00:00
settings.gradle.kts Use gradle version catalogs 2022-06-02 20:28:44 -06:00

README.md

Twigs Server

This is the backend application that powers the Android, iOS, and web applications for Twigs, a personal finance/budgeting app. None of these apps are complete, so expect bugs, and they are all in various stages of development, so expect some feature disparity between platforms.

Prerequisites

  • JDK 14 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

Copyright (C) 2019-2024 William Brawner

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/.