add docs
This commit is contained in:
parent
483ec29d75
commit
2c7fce3c11
26
README.md
Normal file
26
README.md
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
# mimi
|
||||||
|
|
||||||
|
decentralised finance (DeFi) app prototype for the
|
||||||
|
(PolyFinTech100 API Hackathon)[https://www.polyfintech100hackathon.sg/]
|
||||||
|
|
||||||
|
or, rather, the bare minimum of documentation to get this running
|
||||||
|
|
||||||
|
## environment setup
|
||||||
|
|
||||||
|
- python 3.10 and later, or 3.12 to be safe
|
||||||
|
|
||||||
|
- [poetry](https://python-poetry.org/docs/#installation)
|
||||||
|
-
|
||||||
|
- `config.toml`
|
||||||
|
get the `config.toml` very securely stored in the group chat and place it in
|
||||||
|
the repository root / folder you `git clone`-d / downloaded this from
|
||||||
|
|
||||||
|
## running it
|
||||||
|
|
||||||
|
in a terminal, run:
|
||||||
|
|
||||||
|
```text
|
||||||
|
poetry run flet run
|
||||||
|
```
|
||||||
|
|
||||||
|
and the window should pop up
|
Loading…
Reference in a new issue