Getting Started

This document describes how to setup your local development environment for Finala.

Prerequisites

Make sure the following tools are installed:

• Docker
• Golang 1.13.0+ (Installation Manual)
• ElasticSearch
• Node.js & npm

Fork Finala project

ElasticSearch

Run local elasticsearch node for Finala's storage.

docker run -p 9200:9200 -p 5601:5601 nshou/elasticsearch-kibana

Running the different components:

Collector

Please refer to configuration example file to see additional configurations.

go run main.go collector -c ./configuration/collector.yaml

Notifier

Please refer to configuration example file to see additional configurations.

go run main.go notifier -c ./configuration/notifier.yaml

API

Please refer to configuration example file to see additional configurations.

go run main.go api -c ./configuration/api.yaml

UI

Please refer to configuration example file to see additional configurations.

cd ui

npm run dev

OR

make build-ui

go run main.go ui -c ./configuration/ui.yaml

Docker-Compose

Running all components using docker-compose:

docker-compose up

Browse to

You can open a browser and go to http://localhost:8080