-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9d476f6
commit c6ba700
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# DarwinWorld | ||
|
||
## Authors | ||
|
||
[Bartłomiej Kozak](github.com/halotukozak) & [Bartosz Buczek](https://github.com/Corvette653) | ||
|
||
## How to run | ||
|
||
```bash | ||
./gradlew run | ||
``` | ||
|
||
## Modules | ||
|
||
### backend | ||
|
||
Core module, contains all the logic of the application. Coroutines are used for multithreading. | ||
|
||
### frontend | ||
|
||
Contains all the code related to the GUI, separated into Views and ViewModels. We use [TornadoFX](https://tornadofx.io/) | ||
as the proxy between required JavaFX library and Kotlin. | ||
|
||
### metrics | ||
|
||
Custom metrics used for monitoring the application - gathering data about the number of animals, plants, average energy, | ||
etc. | ||
|
||
### shared | ||
|
||
Common utils which extend the functionality of Kotlin's standard library and Flow. |