FE-142: Added read me (#60)

This commit is contained in:
Ildar Galeev 2016-12-22 18:33:58 +03:00 committed by GitHub
parent 3ee25fbe2e
commit 249081ad38

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# Koffing
[![Build Status](http://ci.rbkmoney.com/buildStatus/icon?job=rbkmoney_private/koffing/master)](http://ci.rbkmoney.com/job/rbkmoney_private/view/Frontend/job/koffing/job/master/)
Личный кабинет мерчанта
## Настройка
Конфигурация приложения происходит в файле [appConfig.json](/app/appConfig.json)
Конфигурация keycloak клиента koffing происходит в файле [koffingKeycloakConfig.json](/app/koffingKeycloakConfig.json)
Конфигурация keycloak клиента tokenizer происходит в файле [tokenizationKeycloakConfig.json](/tokenization/tokenizationKeycloakConfig.json)
Для изменения конфигурации в рантайме достаточно заменить нужный json файл
Например в случае с nginx, json файлы нужно положить в `/usr/share/nginx/html`
## Установка и запуск
Для загрузки зависимостей выполнить: ```npm i ```
Далее будут доступны следующие опции:
```npm start``` - запуск приложения на локальном сервере. По умолчанию будет доступен на порту ```8000```. Порт задается в [package.json](/package.json)
```npm build``` - сборка prod версии статики.