From af444620355dfdca139b1dc37f4b9357c1f58eac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Onurcan=20Y=C4=B1lmaz?= Date: Mon, 16 Aug 2021 03:05:36 +0300 Subject: [PATCH] the readme file was changed --- .vscode/settings.json | 1 - README.md | 28 ++++++++++++++++++++++++++-- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 75e571b..d36fc99 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -10,7 +10,6 @@ "**/Properties": true, "**/.sln": false, "**/.md": true, - "**/README.md": true, "**/.gitattributes": true, "**/.gitignore": true, "**/.vs": true diff --git a/README.md b/README.md index 27af146..0283443 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# fuzzy-engine -Serilog kibana .net core services +# Serilog Microservice + +The fuzzy-engine is named from github, thanks for name by github :) + + +fuzzy-engine is a ASP.NET CORE logging micro service by Serilog. It use with Elasticsearch & Kibana and running on the Docker container. + + +FOR WINDOWS USERS + +Firstly, you must install docker desktop. Then you must clone the repository and you will run the docker-compose.yml on the cmd or powershell at your project directory. + +In that; + +``` +docker-compose up -d +``` + +> **NOTE**: The fuzzy-engine is a minimal API by ASP.NET CORE 5. It is not contains any controllers folder. It is running on the middleware. + +> **NOTE**:If you want to see the serilog logs from kibana, you must set up the kibana index pattern with star("*") + + +Then, when you do starting docker, you can start debugging the fuzzy-engine. when you did the request, Kibana will show the logs + +If you like this, give me a star :)