From eb4ee6b10f23b7c5c9a8765d98c89e060fedcf36 Mon Sep 17 00:00:00 2001 From: Lyxminxx Date: Sat, 10 Oct 2026 18:37:57 +0200 Subject: [PATCH] Updated README --- README.md | 74 ++++++------------------------------------------------- 1 file changed, 7 insertions(+), 67 deletions(-) diff --git a/README.md b/README.md index fe0d220..7f98aec 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,9 @@ -# JastFrontend app +# JAST +Welcome to JAST, the spending tracker that simply tracks your spending. Not a bunch of extra fancy stuff. It let's you enter anything you spend or get paid and then gives you some stats. -## Run the app +## Requirements +The only thing you really need to run this locally is docker and docker-compose. If you want to run this without docker, all you need is uv. +The project has two repos, jast the backend and jast-frontend. You do need both. The frontend is written in flet, and is used for the webapp too. There are docker images at [Dockerhub](https://hub.docker.com/repositories/lyxminx). -### uv - -Run as a desktop app: - -```bash -uv run flet run -``` - -Run as a web app: - -```bash -uv run flet run --web -``` - -For more details on running the app, refer to the [Getting Started Guide](https://flet.dev/docs/). - -## Build the app - -### Android - -```bash -flet build apk -v -``` - -For more details on building and signing `.apk` or `.aab`, refer to the [Android Packaging Guide](https://flet.dev/docs/publish/android/). - -### iOS - -```bash -flet build ipa -v -``` - -For more details on building and signing `.ipa`, refer to the [iOS Packaging Guide](https://flet.dev/docs/publish/ios/). - -### macOS - -```bash -flet build macos -v -``` - -For more details on building macOS package, refer to the [macOS Packaging Guide](https://flet.dev/docs/publish/macos/). - -### Linux - -```bash -flet build linux -v -``` - -For more details on building Linux package, refer to the [Linux Packaging Guide](https://flet.dev/docs/publish/linux/). - -### Windows - -```bash -flet build windows -v -``` - -For more details on building Windows package, refer to the [Windows Packaging Guide](https://flet.dev/docs/publish/windows/). - -### Web - -```bash -flet build web -v -``` - -For more details on building Web app, refer to the [Web Packaging Guide](https://flet.dev/docs/publish/web/). +## LLM warning +This project has been assisted by LLM's. If you don't feel comfortable using a project that uses llm's this is not for you.