Files
SHiNE-server/README.md
T

30 lines
3.4 KiB
Markdown

# SHiNE
SHiNE — проект децентрализованного общения: браузерный клиент, сервер, пользовательские блокчейны, личные сообщения и интеграция с Solana и Arweave. Репозиторий содержит также экспериментальные компоненты для ESP32 и браузерное расширение кошелька.
> **Статус:** активная разработка и подготовка к публичному запуску. Исходный код доступен для изучения; самостоятельный запуск возможен, но инструкции по установке ещё дорабатываются. Не все описанные в планах возможности реализованы.
## Как устроен проект
| Компонент | Назначение |
| --- | --- |
| [`shine-UI/`](shine-UI/) | Браузерный клиент и панель администратора сервера |
| [`SHiNE-server/`](SHiNE-server/) | WebSocket/HTTP сервер, PostgreSQL, блокчейн, доставка сообщений |
| [`shine-solana/shine/`](shine-solana/shine/) | Anchor-программы и инструменты Solana |
| [`SHiNE-browser-plugin-wallet/`](SHiNE-browser-plugin-wallet/) | Браузерное расширение кошелька |
| [`ESP32/`](ESP32/) | Прошивки и прототипы устройств |
| [`deploy/`](deploy/) | Скрипты и инструкции по развёртыванию |
Архитектура и границы компонентов описаны в [общей схеме](docs/ARCHITECTURE.md). Пользовательские блоки проектируются для публикации в Arweave; подробности и текущие ограничения тестового контура приведены в [документации блокчейна](docs/Blockchain/README.md).
## Самостоятельный запуск
Основной сервер собирается Gradle из корня репозитория. Для локального запуска предусмотрены `./gradlew startLocal` и `./gradlew startLocalWithBuild`; состав и требования этих задач зависят от локальной конфигурации. Начните с [инструкций по развёртыванию](deploy/README.md) и [примера настроек](application.properties.example). Клиент находится в `shine-UI/`. Публичное пошаговое руководство по установке всего комплекса ещё готовится.
## Документация
- [Каталог документации](docs/README.md) — действующие спецификации, инструкции и планы.
- [Общая архитектура](docs/ARCHITECTURE.md) — компоненты и потоки данных.
- [API](docs/API/09_Operations_Index.md), [формат блокчейна](docs/Blockchain/README.md), [личные сообщения](docs/Personal_Messages/README.md), [Solana](docs/Solana_Architecture/README.md).
- [Правила обновления документации](docs/CONTRIBUTING_DOCS.md).