Loading documentation...
Preparing Ring content
Концепции, ценность и типичные сценарии клонирования — меньше кода.
Концепции, ценность и типичные сценарии клонирования — меньше кода.
Preparing Ring content
Preparing Ring content
Preparing Ring content
Статус: install.sh, ring CLI и вспомогательные скрипты в ring/scripts/ поставляются публично. Более старая документация ссылалась на scripts/setup-dev.sh, npm run setup:env и scripts/run-migration.sh. Их нет в публичном дереве. Для настройки используйте ./install.sh, а для базы данных web/data/schema.sql. Используйте вкладки Основатель / Разработчик на боковой панели, чтобы отфильтровать эту страницу.
После переезда приложения в web/ у публичного репозитория три слоя инструментов: корневой лаунчер, собственные npm-скрипты приложения Next.js и общие вспомогательные скрипты на shell и Node в ring/scripts/. Таблица сопоставляет то, что советовали запускать старые руководства, с тем, что существует сейчас.
| Раньше в документации | Используйте сейчас |
|---|---|
./scripts/setup-dev.sh | ./install.sh (режим dev используется по умолчанию) |
npm run setup:env (scripts/setup-env.js) | ./install.sh записывает .env.local, или npm run setup:portal копирует шаблон |
./scripts/run-migration.sh | psql -f web/data/schema.sql на новой базе данных |
| Ring CLI доступен только в enterprise | npm run cli:install, затем ring --help. См. Ring CLI |
ring deploy prod | ring prod (только Kubernetes) |
./install.sh проверяет машину, устанавливает пакеты и записывает вашу конфигурацию и файл секретов.
ring upgrade показывает изменения Ring из upstream до того, как что-либо затронет ваш клон.
ring-config.json хранит ваш бренд. Инструменты никогда не перезаписывают его без запроса.
git clone до работающего клона с одним мастером и одним файлом схемы.Статус: install.sh, ring CLI и вспомогательные скрипты в ring/scripts/ поставляются публично. Более старая документация ссылалась на scripts/setup-dev.sh, npm run setup:env и scripts/run-migration.sh. Их нет в публичном дереве. Для настройки используйте ./install.sh, а для базы данных web/data/schema.sql. Используйте вкладки Основатель / Разработчик на боковой панели, чтобы отфильтровать эту страницу.
После переезда приложения в web/ у публичного репозитория три слоя инструментов: корневой лаунчер, собственные npm-скрипты приложения Next.js и общие вспомогательные скрипты на shell и Node в ring/scripts/. Таблица сопоставляет то, что советовали запускать старые руководства, с тем, что существует сейчас.
| Раньше в документации | Используйте сейчас |
|---|---|
./scripts/setup-dev.sh | ./install.sh (режим dev используется по умолчанию) |
npm run setup:env (scripts/setup-env.js) | ./install.sh записывает .env.local, или npm run setup:portal копирует шаблон |
./scripts/run-migration.sh | psql -f web/data/schema.sql на новой базе данных |
| Ring CLI доступен только в enterprise | npm run cli:install, затем ring --help. См. Ring CLI |
ring deploy prod | ring prod (только Kubernetes) |
./install.sh проверяет машину, устанавливает пакеты и записывает вашу конфигурацию и файл секретов.
ring upgrade показывает изменения Ring из upstream до того, как что-либо затронет ваш клон.
ring-config.json хранит ваш бренд. Инструменты никогда не перезаписывают его без запроса.
git clone до работающего клона с одним мастером и одним файлом схемы.Статус: install.sh, ring CLI и вспомогательные скрипты в ring/scripts/ поставляются публично. Более старая документация ссылалась на scripts/setup-dev.sh, npm run setup:env и scripts/run-migration.sh. Их нет в публичном дереве. Для настройки используйте ./install.sh, а для базы данных web/data/schema.sql. Используйте вкладки Основатель / Разработчик на боковой панели, чтобы отфильтровать эту страницу.
После переезда приложения в web/ у публичного репозитория три слоя инструментов: корневой лаунчер, собственные npm-скрипты приложения Next.js и общие вспомогательные скрипты на shell и Node в ring/scripts/. Таблица сопоставляет то, что советовали запускать старые руководства, с тем, что существует сейчас.
| Раньше в документации | Используйте сейчас |
|---|---|
./scripts/setup-dev.sh | ./install.sh (режим dev используется по умолчанию) |
npm run setup:env (scripts/setup-env.js) | ./install.sh записывает .env.local, или npm run setup:portal копирует шаблон |
./scripts/run-migration.sh | psql -f web/data/schema.sql на новой базе данных |
| Ring CLI доступен только в enterprise | npm run cli:install, затем ring --help. См. Ring CLI |
ring deploy prod | ring prod (только Kubernetes) |
./install.sh проверяет машину, устанавливает пакеты и записывает вашу конфигурацию и файл секретов.
ring upgrade показывает изменения Ring из upstream до того, как что-либо затронет ваш клон.
ring-config.json хранит ваш бренд. Инструменты никогда не перезаписывают его без запроса.
git clone до работающего клона с одним мастером и одним файлом схемы../install.sh prod |
Выбор между Vercel, Ubuntu по SSH или Kubernetes (использует ваши собственные k8s/*.yaml) |
./install.sh sync-urls --domain HOST | Исправляет расхождение NEXT_PUBLIC_API_URL и AUTH_URL. --port для локальной работы |
./install.sh setup-db | Должен создавать БД и применять schema.sql. Сейчас не работает на публичных checkout (см. бэклог) |
Корневой ring/install.sh только переходит в web/ и запускает web/install.sh.
ring/web/package.json)| Скрипт | Что запускает |
|---|---|
dev, build, start | Собственный сервер server.ts. build сначала выполняет ensure:config и type-check |
type-check, lint, test, test:coverage | tsc, next lint, jest |
ensure:config, setup:portal | scripts/ensure-ring-config.sh, копирование шаблона |
validate:fcm-env, validate:fcm-schema | Проверки env для FCM и JSONB fcm_tokens |
db:flatten-schema | Пересобирает data/schema.sql из миграций (нужен локальный Postgres) |
smoke:pipelines | scripts/run-all-smokes.sh |
cli:install, cli:dev | Ring CLI |
check:org-leak, compose:shadow | Проверки гигиены Layer 1 для контрибьюторов |
Из корня репозитория npm run dev, build и start делегируют выполнение в web/ через scripts/run-web.sh.
Они всё ещё перечислены в web/package.json, но их целевых файлов в репозитории нет, поэтому они завершаются ошибкой: setup, setup:env, setup:new, config:firebase, seed:opportunities, seed:portal, optimize:firebase, migrate:services, fix:service-migration, fix:compilation-errors, test:firebase-optimization, portal:health, portal:analytics. db:apply-schema и db:setup находят свои цели, но падают из-за несоответствия путей.
ci:layer1, push:layer1, push:forgejo, push:github-oss, setup:org-dx и merge:org-dev требуют приватного оверлея и forge Ringdom. Они не предназначены для клонов сообщества.
./install.sh prod |
Выбор между Vercel, Ubuntu по SSH или Kubernetes (использует ваши собственные k8s/*.yaml) |
./install.sh sync-urls --domain HOST | Исправляет расхождение NEXT_PUBLIC_API_URL и AUTH_URL. --port для локальной работы |
./install.sh setup-db | Должен создавать БД и применять schema.sql. Сейчас не работает на публичных checkout (см. бэклог) |
Корневой ring/install.sh только переходит в web/ и запускает web/install.sh.
ring/web/package.json)| Скрипт | Что запускает |
|---|---|
dev, build, start | Собственный сервер server.ts. build сначала выполняет ensure:config и type-check |
type-check, lint, test, test:coverage | tsc, next lint, jest |
ensure:config, setup:portal | scripts/ensure-ring-config.sh, копирование шаблона |
validate:fcm-env, validate:fcm-schema | Проверки env для FCM и JSONB fcm_tokens |
db:flatten-schema | Пересобирает data/schema.sql из миграций (нужен локальный Postgres) |
smoke:pipelines | scripts/run-all-smokes.sh |
cli:install, cli:dev | Ring CLI |
check:org-leak, compose:shadow | Проверки гигиены Layer 1 для контрибьюторов |
Из корня репозитория npm run dev, build и start делегируют выполнение в web/ через scripts/run-web.sh.
Они всё ещё перечислены в web/package.json, но их целевых файлов в репозитории нет, поэтому они завершаются ошибкой: setup, setup:env, setup:new, config:firebase, seed:opportunities, seed:portal, optimize:firebase, migrate:services, fix:service-migration, fix:compilation-errors, test:firebase-optimization, portal:health, portal:analytics. db:apply-schema и db:setup находят свои цели, но падают из-за несоответствия путей.
ci:layer1, push:layer1, push:forgejo, push:github-oss, setup:org-dx и merge:org-dev требуют приватного оверлея и forge Ringdom. Они не предназначены для клонов сообщества.
./install.sh prod |
Выбор между Vercel, Ubuntu по SSH или Kubernetes (использует ваши собственные k8s/*.yaml) |
./install.sh sync-urls --domain HOST | Исправляет расхождение NEXT_PUBLIC_API_URL и AUTH_URL. --port для локальной работы |
./install.sh setup-db | Должен создавать БД и применять schema.sql. Сейчас не работает на публичных checkout (см. бэклог) |
Корневой ring/install.sh только переходит в web/ и запускает web/install.sh.
ring/web/package.json)| Скрипт | Что запускает |
|---|---|
dev, build, start | Собственный сервер server.ts. build сначала выполняет ensure:config и type-check |
type-check, lint, test, test:coverage | tsc, next lint, jest |
ensure:config, setup:portal | scripts/ensure-ring-config.sh, копирование шаблона |
validate:fcm-env, validate:fcm-schema | Проверки env для FCM и JSONB fcm_tokens |
db:flatten-schema | Пересобирает data/schema.sql из миграций (нужен локальный Postgres) |
smoke:pipelines | scripts/run-all-smokes.sh |
cli:install, cli:dev | Ring CLI |
check:org-leak, compose:shadow | Проверки гигиены Layer 1 для контрибьюторов |
Из корня репозитория npm run dev, build и start делегируют выполнение в web/ через scripts/run-web.sh.
Они всё ещё перечислены в web/package.json, но их целевых файлов в репозитории нет, поэтому они завершаются ошибкой: setup, setup:env, setup:new, config:firebase, seed:opportunities, seed:portal, optimize:firebase, migrate:services, fix:service-migration, fix:compilation-errors, test:firebase-optimization, portal:health, portal:analytics. db:apply-schema и db:setup находят свои цели, но падают из-за несоответствия путей.
ci:layer1, push:layer1, push:forgejo, push:github-oss, setup:org-dx и merge:org-dev требуют приватного оверлея и forge Ringdom. Они не предназначены для клонов сообщества.