At the moment readme doesn't help much on, starting project and general understanding what does this repo contains
I suggest add following things to readme:
1) What this repo contains, maybe some brief on folder structures and .env variables
2) Describe why proxy backend is required, how to start it etc.
3) Describe prerequisites e.g. api key should be obtained from DevPortal
4) Clear instructions on how to launch project
5) Mention releases artifacts e.g. electron app
DKotsyuba
commented
3 months ago
At the moment readme doesn't help much on, starting project and general understanding what does this repo contains
I suggest add following things to readme: 1) What this repo contains, maybe some brief on folder structures and .env variables 2) Describe why proxy backend is required, how to start it etc. 3) Describe prerequisites e.g. api key should be obtained from DevPortal 4) Clear instructions on how to launch project 5) Mention releases artifacts e.g. electron app