Концепції, цінність і типові сценарії
Концепції, цінність і типові сценарії
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. Вони не призначені для клонів спільноти.