- Корневой README обновлён с актуальной структурой и командами
- 13 компонентных README с единым стилем: описание, фичи, скрипты, архитектура, тесты
- Обновлены description в package.json всех компонентов
- Новые README для cleos и setup (ранее отсутствовали)
Co-authored-by: Alex Ant <dacom-dark-sun@users.noreply.github.com>
Система управления взаимоотношениями в кооперативе. Включает в себя полный комплект программного обеспечения для подключения к платформе "Кооперативная Экономика" и управления взаимоотношениями с пайщиками в кооперативе и самим кооперативом на основе смарт-контрактов и простой электронной подписи.
Платформа «Цифровой Кооператив» — комплексное программное обеспечение для управления кооперативными организациями на основе блокчейна EOSIO. Система обеспечивает полный цикл управления кооперативом: от регистрации пайщиков и электронного документооборота до проведения собраний и финансового учёта. Построена на принципах прозрачности, децентрализации и простой электронной подписи.
- Для разработки используется ветка `dev`.
- Для стейджа используется ветка `testnet`.
- Для продакшена используется ветка `main`.
Проект является частью экосистемы [Кооперативная Экономика](https://coopenomics.world).
## Установка
## Архитектура
```sh
| Компонент | Пакет | Описание |
|-----------|-------|----------|
| [boot](components/boot) | `@coopenomics/boot` | CLI для инициализации и управления блокчейн-инфраструктурой |
| [cleos](components/cleos) | `@coopenomics/cleos` | Утилита командной строки для работы с блокчейн-кошельком |
| [contracts](components/contracts) | `@coopenomics/contracts` | Смарт-контракты EOSIO на C++ |
| [controller](components/controller) | `@coopenomics/controller` | GraphQL API сервер (NestJS) |
| [factory](components/factory) | `@coopenomics/factory` | Генератор юридических документов |
| [migrator](components/migrator) | `migrator` | Утилита миграции данных |
| [notifications](components/notifications) | `@coopenomics/notifications` | Библиотека уведомлений на основе Novu |
| [parser](components/parser) | `@coopenomics/parser` | Индексатор блокчейна через State History Plugin |
| [sdk](components/sdk) | `@coopenomics/sdk` | TypeScript SDK для GraphQL API |
| [setup](components/setup) | `@coopenomics/setup` | Мастер первоначальной настройки |
## Быстрый старт
### Предварительные требования
- Node.js >= 20
- pnpm 9
- Docker и Docker Compose
- [WeasyPrint](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation) (для генерации PDF)
### Установка
```bash
pnpm install
```
Также для работы потребуется установленная фабрика документов `weasyprint` для вашей операционной системы: <https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation>
### Конфигурация
## Конфигурация
Для конфигурации потребуетcя установленный `docker` и `docker-compose`. Выполните команду и следуйте инструкциям:
```sh
```bash
pnpm run setup
```
## Запуск
Интерактивный мастер создаст необходимые `.env` файлы для всех компонентов.
### Инфраструктура
### Запуск инфраструктуры
Для работы системы необходимы базы `mongo`, `postgres` и `redis`.
Команда запуска баз данных в контейнерах для работы в фоновом режиме:
```sh
```bash
docker compose up -d
pnpm run reboot
```
### Блокчейн и контракты
## Разработка
```sh
pnpm boot
```
### Бэкенд (controller + parser)
Команда запустит блокчейн и установит все смарт-контракты, подготовив систему к локальной разработке или применению.
### Бэкенд
```sh
```bash
pnpm run dev:backend
```
Команда запустит набор сервисов бэкенда и точку доступа GraphQL-API на 2998 порту.
### Фронтенд (desktop)
### Фронтенд
Команда запустит рабочий стол кооператива на 3005 порту:
```sh
```bash
pnpm run dev:desktop
```
### Очистка базы
### Библиотеки (factory + cooptypes)
Команда очистит базу mongodb и начнет производство блоков с начала:
```sh
pnpm run clear
```bash
pnpm run dev:lib
```
Правильная последовательность команд при переустановке проекта "с нуля":
### Все сервисы одновременно
```sh
git pull
pnpm install
pnpm run setup
pnpm run clear
pnpm run boot
pnpm run dev:backend
pnpm run dev:desktop
```bash
pnpm run dev:all
```
### Кошелёк
Для работы с кошельком блокчейна используется утилита cleos, которая позволяет извлекать таблицы смарт-контрактов и отправлять транзакции в блокчейн если это требуется.
> **Примечание:** установка пакетов производится только через фильтр: `pnpm add <пакет> --filter <компонент>`
Для работы с командным кошельком `cleos` локально необходимо чтобы инфраструктура была поднята:
## Тестирование
```
docker compose up -d
```bash
# Все тесты
pnpm run test
# Юнит-тесты (cooptypes, parser, notifications)
pnpm run test:unit
# Компонентные тесты (factory)
pnpm run test:component
# Интеграционные тесты (boot + blockchain)
pnpm run test:integration
```
Запускаем контейнер с кошельком и входим в него командой:
## Сборка
```
pnpm run cleos
```
```bash
# Библиотеки (cooptypes, factory)
pnpm run build:lib
В кошельке уже находится дефолтный ключ для работы с локальной средой. Этот ключ зашифрован паролем. Пароль хранится в файле `password` и используется автоматически при разблокировке. Для разблокировки кошелька, находясь в контейнере выполняем:
# Смарт-контракты
pnpm run build:contracts:all
# Desktop (SSR)
pnpm --filter @coopenomics/desktop run build
```
./unlock.sh
```
Для использования кошелька выполняем:
```
./cleos.sh <command>
```
Для получения полного списка команд вызываем кошелек без команд:
```
./cleos.sh
```
Например, для получения информации о текущем состоянии блокчейна:
```
./cleos.sh get info
```
### Возможные проблемы
В случае, если при выполнении ./unlock.sh возникает проблема:
`Unable to connect to keosd, if keosd is running please kill the process and try again`, то выполните команду:
```
./reset.sh
```
Данная команда удалит созданный ранее сокет кошелька, после чего, выполните ./unlock.sh повторно.
## Лицензия
Продукт Потребительского Кооператива "ВОСХОД" распространяется по лицензии BY-NC-SA 4.0.
Продукт Потребительского Кооператива «ВОСХОД» распространяется по лицензии [BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.ru).
Разрешено делиться, копировать и распространять материал на любом носителе и форме, адаптировать, делать ремиксы, видоизменять и создавать новое, опираясь на этот материал. При использовании, Вы должны обеспечить указание авторства, предоставить ссылку, и обозначить изменения, если таковые были сделаны. Если вы перерабатываете, преобразовываете материал или берёте его за основу для производного произведения, вы должны распространять переделанные вами части материала на условиях той же лицензии , в соответствии с которой распространяется оригинал. Запрещено коммерческое использование материала. Использование в коммерческих целях – это использование, в первую очередь направленное на получение коммерческого преимущества или денежного вознаграждения.
Юридический текст лицензии: <https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.ru>
Разрешено делиться, копировать и распространять материал, адаптировать и создавать производные произведения при условии указания авторства и сохранения той же лицензии. Коммерческое использование запрещено.
"description":"Интерактивный мастер настройки окружения",
"main":"index.js",
"scripts":{
"setup":"esno ./setup.ts"
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Cursor Agent