62 lines
1.9 KiB
Markdown
62 lines
1.9 KiB
Markdown
# CSEP FoodPal Application (Team 76)
|
|
|
|
## Usage
|
|
|
|
The project uses Java 25. Make sure you have the correct Java version installed.
|
|
|
|
### Client
|
|
|
|
The client needs to be launched **after** a server is already running, see Usage.Server section:
|
|
|
|
```
|
|
mvn -pl client -am javafx:run
|
|
```
|
|
|
|
### Server
|
|
|
|
By default, the server listens to the port `8080`.
|
|
[TODO(1)]:: Configurable port.
|
|
|
|
```
|
|
mvn -pl server -am spring-boot:run
|
|
```
|
|
|
|
## Features
|
|
|
|
- Recipe tracking in an intuitive GUI.
|
|
- Ability to input arbitrary amounts of an ingredient in a recipe. The design is very human. See Manual.Ingredients for more usage details.
|
|
- Native localization in more than 2, and less than 4 languages.
|
|
- Configurable via JSON, See Manual.Configuration.
|
|
|
|
## Manual
|
|
|
|
### Configuration
|
|
|
|
The configuration is with JSON, read from `config.json` in the working directory. We illustrate an example configuration below.
|
|
```json
|
|
{
|
|
"language": "en",
|
|
"serverUrl": "http://localhost:8080",
|
|
"favourites": [
|
|
1,
|
|
],
|
|
"shoppingList": [
|
|
"Ingredient A",
|
|
],
|
|
}
|
|
```
|
|
#### Options
|
|
|
|
- `language: string`
|
|
- One of \[en, nl, pl\] (as of Jan 11 2026)
|
|
- `serverUrl: string`
|
|
- The host that the FoodPal server runs on, see configuration example.
|
|
- `favourites: [number]`
|
|
- The list of recipe IDs that the user has marked as favourite.
|
|
- `shoppingList: [string]`
|
|
- The list of ingredients that the user has in their shopping list.
|
|
|
|
### Ingredients
|
|
|
|
- To input a **formal** ingredient, you write the numeric amount in the first input box, then the Unit in the selection dropdown, and then write the name of the ingredient, e.g. salt, apples, etc. should it be not visible already on the platform.
|
|
- To input an **informal** ingredient, describe the amount in the first input box, like "some of", or "a sprinkle of", then select "<NONE>" in the unit selection box, and write the name of your ingredient or pick from one of the availables from the dropdown.
|