chore: update README to express implemented features
This commit is contained in:
parent
33e7c7386e
commit
91a8a13369
1 changed files with 11 additions and 11 deletions
22
README.md
22
README.md
|
|
@ -6,27 +6,27 @@ The project uses Java 25. Make sure you have the correct Java version installed.
|
||||||
|
|
||||||
### Client
|
### Client
|
||||||
|
|
||||||
The client needs to be launched **after** a server is already running, see Usage.Server section:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
mvn -pl client -am javafx:run
|
mvn -pl client -am javafx:run
|
||||||
```
|
```
|
||||||
|
|
||||||
### Server
|
### Server
|
||||||
|
|
||||||
By default, the server listens to the port `8080`.
|
By default, the server listens to the port `8080`. If the server is not available, the next immediate free port is opened. You can run the server with:
|
||||||
[TODO(1)]:: Configurable port.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
mvn -pl server -am spring-boot:run
|
mvn -pl server -am spring-boot:run
|
||||||
```
|
```
|
||||||
|
|
||||||
## Features
|
## Implemented features
|
||||||
|
|
||||||
- Recipe tracking in an intuitive GUI.
|
- Full 4.1 basic requirements criteria. Print/Export functionality exports a plain-text file of the recipe to a file in a location of the user's choosing.
|
||||||
- Ability to input arbitrary amounts of an ingredient in a recipe. The design is very human. See Manual.Ingredients for more usage details.
|
- Full 4.2 WebSocket modelling. We have implemented all points in the backlog and created a compliant solution using distinct STOMP messages that distribute handling to multiple distinct callbacks. We also implemented a meaningful addition as an "Updated at {Time}" utility prompt such that the application hints to the user when it may be time to perform a manual refresh to stay up-to-date.
|
||||||
- Native localization in more than 2, and less than 4 languages.
|
- Full 4.3 Nutrition view and list of ingredients. We have implemented each criteria in the product backlog pertaining to this section to a satisfactory level.
|
||||||
- Configurable via JSON, See Manual.Configuration.
|
When in confusion, the user should consult Manual.Ingredients section of this file to see how to add an informal or formal ingredient.
|
||||||
|
We also include a meaningful addition into the application as a pie chart describing the nutritional composition of each recipe between proteins, carbohydrates, and fats, so that the end user gets a much more straightforward presentation for their dietary choices.
|
||||||
|
- Full 4.4 search functionality implemented. Each criteria is met to satisfactory standards and the client submits a search query to the backend with a list of parameters, to which the client proceeds to respond.
|
||||||
|
- Full 4.5 Shopping list functionality. We implemented a functional shopping list to which the user can add/delete/edit ingredients to, as well as an Add Overview when the user decides to add ingredients of a recipe into their shopping list. Printing the list to a file is also supported.
|
||||||
|
- Full 4.6 functionality. All parts of the UI buttons have been linked to their respective resource items. The application has support for 7 languages, including English, Dutch, Chinese (Simplified/Traditional), Polish, Turkish, and toki pona. We include a national flag for each language in a language selection menu for easier interaction with the end user.
|
||||||
|
|
||||||
## Manual
|
## Manual
|
||||||
|
|
||||||
|
|
@ -58,5 +58,5 @@ The configuration is with JSON, read from `config.json` in the working directory
|
||||||
|
|
||||||
### Ingredients
|
### 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 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 from the dropdown.
|
||||||
- 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.
|
- 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.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue