README updates

This commit is contained in:
Nicholas
2025-11-22 16:07:56 -05:00
parent 7347b53bfe
commit eb8dcc0f36
2 changed files with 22 additions and 65 deletions

View File

@@ -1,81 +1,38 @@
# Meal Picker app
An app made to help keep track of ingredients for meals, and to build markdown
checklists for shopping.
## Files:
### .env
A file containing the path you want to save the final checklist to. Defaults to current folder.
### src/json/ingredients.json
A file containing the JSON representation of meals and their ingredients. Will be created if one does not exist.
## Run the app
### uv
### CLI
Run as a desktop app:
Create a virtual environment:
```
uv run flet run
source .venv/bin/activate
```
Run as a web app:
Install required packages:
```
uv run flet run --web
pip install -r requirements.txt
```
### Poetry
Install dependencies from `pyproject.toml`:
Run the flet app:
```
poetry install
flet run MealSelector.py
```
OR
```
flet run MealBuilder.py
```
Run as a desktop app:
```
poetry run flet run
```
Run as a web app:
```
poetry run flet run --web
```
For more details on running the app, refer to the [Getting Started Guide](https://flet.dev/docs/getting-started/).
## Build the app
### Android
```
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
```
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
```
flet build macos -v
```
For more details on building macOS package, refer to the [macOS Packaging Guide](https://flet.dev/docs/publish/macos/).
### Linux
```
flet build linux -v
```
For more details on building Linux package, refer to the [Linux Packaging Guide](https://flet.dev/docs/publish/linux/).
### Windows
```
flet build windows -v
```
For more details on building Windows package, refer to the [Windows Packaging Guide](https://flet.dev/docs/publish/windows/).
For more details, go to the [Flet website](https://flet.dev/)

View File

@@ -5,7 +5,7 @@ from dotenv import load_dotenv
load_dotenv()
file_path = os.getenv("file_path") if os.getenv("file_path") else "./checklist.md"
file_path = os.getenv("FILE_PATH") + "/checklist.md" if os.getenv("FILE_PATH") else "./checklist.md"
def read_json() -> dict:
try: