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
68 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
William Brawner e160fd372e Add README
2020-12-27 14:28:13 -07:00
api Implement category archiving 2020-06-30 03:18:24 +00:00
gradle/wrapper Update to Gradle 6.4 2020-05-31 13:23:28 -07:00
.gitignore Add missing gradle files 2020-02-12 20:06:05 -07:00
build.gradle Convert the rest of the codebase from Kotlin to Java 2020-05-31 22:06:21 -07:00
captain-definition Configure caprover deployments 2019-05-22 21:54:15 -07:00
docker-compose.yml Add Angular app to dev docker-compose.yml CORS exceptions 2020-05-26 18:48:47 -07:00
Dockerfile Update Dockerfile to use JDK 14 2020-06-01 08:03:35 -07: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 Add license 2019-10-03 15:24:43 -07:00
README.md Add README 2020-12-27 14:28:13 -07:00
settings.gradle Move source into api module 2020-05-31 13:23:28 -07: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.

Prerequisites

  • JDK 14 or newer
  • MySQL 5.7 or newer
  • (optional) Docker

Running

Prior to running the app, make sure you have a MySQL 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 MySQL server running, you can run the app from the command line with gradle:

./gradlew bootRun

By default, twigs will try to connect to the budget database on localhost, using budget as the user and password. To change these values, you can modify the api/src/main/resources/application.properties file (but don't commit it!), or better yet, set the appropriate environment variables using the uppercase names and replacing the .s with _s. For example, to change the spring.datasource.username property (the database username), you could set the value in an environment variable called SPRING_DATASOURCE_USERNAME.

Building

Building the app is also handled with gradle:

./gradlew bootJar