15 lines
702 B
Markdown
15 lines
702 B
Markdown
|
# Finnow
|
||
|
|
|
||
|
|
A financial tracking and planning application for individuals!
|
||
|
|
|
||
|
|
This application consists of a backend API that separately stores and accesses each user's data, and a Flutter-based frontend for desktop and mobile applications for users.
|
||
|
|
|
||
|
|
There's a `run.sh` script available in the main directory to help with running the various parts of the app. The following commands are available:
|
||
|
|
|
||
|
|
|Command|Description|
|
||
|
|
|--- |--- |
|
||
|
|
|`./run.sh api`|Runs the API locally for development.|
|
||
|
|
|`./run.sh app`|Runs the app locally for development.|
|
||
|
|
|`./run.sh clean`|Cleans all projects of build artefacts and other temporary files.|
|
||
|
|
|`./run.sh build`|Builds all projects to produce artefacts for final usage.|
|