personal-finances

Dev Setup

Install Tools

Uses VS Code with Remote containers, you must install

• Docker Desktop Windows or Mac
• VS Code
• VS Code Remote Container Extension.
• Git, id suggest GitKraken but any will do.

Clone Repo

Run git clone https://github.com/G3N7/personal-finances in what ever directory you like, to bring the code down locally.

Opening Project

• Open VS Code, and Open Folder in it.
• Click the little green button in the bottom left of VSCode to reopen inside of a container.
• Once the environment is setup for the first time it will open much faster.
• run npm start to build and run the applications hosted via npm.
• In a browser open a tab to the following URLs and you should see:
  • Kibana - The Kibana web interface that lets you build visualizations around the Transaciton Data
  • Angular App - This is our little import tool website we are building
  • Elastic Search API - This is basically the "database" for the Kibana UI, we are using our import tool to fill this database up in a way that Kibana can index/visualize.

Troubleshooting

If your Kibana frontend cannot be reached or you cannot contact the elastic search API, you should open the docker log for the sebp/elk container running in your docker desktop, and look for an error line. The most common problem is the following error where the defaults need to be raised.

bootstrap check failure [1] of [1]: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]

If you see this error set the max map count for your VM, then restart and you should be squared away.