From b2b836b98272c4d6add7c3f9d7dc2b529397d158 Mon Sep 17 00:00:00 2001
From: violog <51th.apprent1ce.f0rce@gmail.com>
Date: Tue, 16 Jul 2024 17:50:13 +0300
Subject: [PATCH] first commit

---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bb3ba24
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# galxe-svc
+
+## Description
+
+Integration with Galxe
+
+## Install
+
+  ```
+  git clone github.com/rarimo/galxe-svc
+  cd galxe-svc
+  go build main.go
+  export KV_VIPER_FILE=./config.yaml
+  ./main run service
+  ```
+
+## Documentation
+
+We do use openapi:json standard for API. We use swagger for documenting our API.
+
+To open online documentation, go to [swagger editor](http://localhost:8080/swagger-editor/) here is how you can start it
+```
+  cd docs
+  npm install
+  npm start
+```
+To build documentation use `npm run build` command,
+that will create open-api documentation in `web_deploy` folder.
+
+To generate resources for Go models run `./generate.sh` script in root folder.
+use `./generate.sh --help` to see all available options.
+
+Note: if you are using Gitlab for building project `docs/spec/paths` folder must not be
+empty, otherwise only `Build and Publish` job will be passed.  
+
+## Running from docker 
+  
+Make sure that docker installed.
+
+use `docker run ` with `-p 8080:80` to expose port 80 to 8080
+
+  ```
+  docker build -t github.com/rarimo/galxe-svc .
+  docker run -e KV_VIPER_FILE=/config.yaml github.com/rarimo/galxe-svc
+  ```
+
+## Running from Source
+
+* Set up environment value with config file path `KV_VIPER_FILE=./config.yaml`
+* Provide valid config file
+* Launch the service with `run service` command
+
+
+
+### Third-party services
+
+
+## Contact
+
+Responsible 
+The primary contact for this project is  [//]: # (TODO: place link to your telegram and email)