Add public-release README with installation and safety checklist
This commit is contained in:
51
public-release/README.md
Normal file
51
public-release/README.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# Public Release: VK Gateway + Paradiz
|
||||
|
||||
Пакет содержит 2 скилла для OpenClaw:
|
||||
|
||||
- `vk-gateway` — приём сообщений из VK (Bots Long Poll), ответы через OpenClaw, отправка файлов брони в чат VK.
|
||||
- `paradiz` — логика расчёта/бронирования и генерация листа брони.
|
||||
|
||||
## Состав
|
||||
|
||||
```text
|
||||
public-release/
|
||||
vk-gateway/
|
||||
paradiz/
|
||||
README.md
|
||||
```
|
||||
|
||||
## Установка (локально)
|
||||
|
||||
Из корня вашего workspace OpenClaw:
|
||||
|
||||
```bash
|
||||
# 1) скопировать скиллы
|
||||
cp -R public-release/vk-gateway skills/
|
||||
cp -R public-release/paradiz skills/
|
||||
|
||||
# 2) создать env для VK
|
||||
cp skills/vk-gateway/.env.example skills/vk-gateway/.env
|
||||
|
||||
# 3) заполнить минимум в skills/vk-gateway/.env:
|
||||
# VK_GROUP_ID=...
|
||||
# VK_TOKEN=...
|
||||
# OPENCLAW_GATEWAY_TOKEN=...
|
||||
|
||||
# 4) запустить endpoint и longpoll
|
||||
node skills/vk-gateway/vk-endpoint.mjs --env skills/vk-gateway/.env
|
||||
node skills/vk-gateway/vk-longpoll.mjs --env skills/vk-gateway/.env
|
||||
```
|
||||
|
||||
## Важно по публикации
|
||||
|
||||
- В репозиторий не добавлять `*.env` с реальными токенами.
|
||||
- В репозиторий не добавлять рабочие `data/` и локальные базы.
|
||||
- В текущем релизе цены в `paradiz/references/prices*.csv` выставлены в `0`.
|
||||
|
||||
## Проверка перед push
|
||||
|
||||
```bash
|
||||
grep -RIn -E 'vk1\.a\.|OPENCLAW_GATEWAY_TOKEN=|[0-9]{8,}:[A-Za-z0-9_-]{20,}|PARADIZ_TG_BOT_TOKEN' .
|
||||
```
|
||||
|
||||
Если grep ничего не вернул (кроме шаблонных заглушек в `.env.example`) — можно публиковать.
|
||||
Reference in New Issue
Block a user