Concepts, value, and typical clone scenarios — less code.
Concepts, value, and typical clone scenarios — less code.
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Filter with Founder / Developer in the docs sidebar. Run this after Installation and Migrations. Estimated time: 10–15 minutes for core checks; Web3 and payments are optional follow-ups.
First success means the dev server serves pages, Auth.js can establish a session, DatabaseService reads/writes without adapter errors, and core marketplace routes load. It does not require WayForPay, FCM, or wallet connectivity on day one.
| Level | Criteria | Good enough to… |
|---|---|---|
| Core | Homepage + /api/health + sign-in + one CRUD path | Customize branding, invite testers |
| Extended | Tunnel test ready, entities + opportunities UI | Demo realtime notifications |
| Optional | Wallet balance, Web3 connect, payments sandbox | Token / checkout features |
Before showing the clone to stakeholders, confirm the happy path a member would take:
| Check | Pass? |
|---|---|
npm run dev starts without DB adapter crash | ☐ |
GET /api/health → healthy or fix AUTH_SECRET | ☐ |
| Sign-in completes for one Auth.js provider | ☐ |
| Entity create/list works in UI | ☐ |
| Opportunities list loads | ☐ |
GET /api/tunnel/test → status: ready | ☐ |
ring-config.json and themes after smoke pass.
Feature exploration and deployment pointers.
Wire health checks and analytics after deploy.
Common auth and database fixes.
Core checks green? Explore features with Welcome or open the admin analytics path once you have an admin account (Monitoring).
Filter with Founder / Developer in the docs sidebar. Run this after Installation and Migrations. Estimated time: 10–15 minutes for core checks; Web3 and payments are optional follow-ups.
First success means the dev server serves pages, Auth.js can establish a session, DatabaseService reads/writes without adapter errors, and core marketplace routes load. It does not require WayForPay, FCM, or wallet connectivity on day one.
| Level | Criteria | Good enough to… |
|---|---|---|
| Core | Homepage + /api/health + sign-in + one CRUD path | Customize branding, invite testers |
| Extended | Tunnel test ready, entities + opportunities UI | Demo realtime notifications |
| Optional | Wallet balance, Web3 connect, payments sandbox | Token / checkout features |
Before showing the clone to stakeholders, confirm the happy path a member would take:
| Check | Pass? |
|---|---|
npm run dev starts without DB adapter crash | ☐ |
GET /api/health → healthy or fix AUTH_SECRET | ☐ |
| Sign-in completes for one Auth.js provider | ☐ |
| Entity create/list works in UI | ☐ |
| Opportunities list loads | ☐ |
GET /api/tunnel/test → status: ready | ☐ |
ring-config.json and themes after smoke pass.
Feature exploration and deployment pointers.
Wire health checks and analytics after deploy.
Common auth and database fixes.
Core checks green? Explore features with Welcome or open the admin analytics path once you have an admin account (Monitoring).
Filter with Founder / Developer in the docs sidebar. Run this after Installation and Migrations. Estimated time: 10–15 minutes for core checks; Web3 and payments are optional follow-ups.
First success means the dev server serves pages, Auth.js can establish a session, DatabaseService reads/writes without adapter errors, and core marketplace routes load. It does not require WayForPay, FCM, or wallet connectivity on day one.
| Level | Criteria | Good enough to… |
|---|---|---|
| Core | Homepage + /api/health + sign-in + one CRUD path | Customize branding, invite testers |
| Extended | Tunnel test ready, entities + opportunities UI | Demo realtime notifications |
| Optional | Wallet balance, Web3 connect, payments sandbox | Token / checkout features |
Before showing the clone to stakeholders, confirm the happy path a member would take:
| Check | Pass? |
|---|---|
npm run dev starts without DB adapter crash | ☐ |
GET /api/health → healthy or fix AUTH_SECRET | ☐ |
| Sign-in completes for one Auth.js provider | ☐ |
| Entity create/list works in UI | ☐ |
| Opportunities list loads | ☐ |
GET /api/tunnel/test → status: ready | ☐ |
ring-config.json and themes after smoke pass.
Feature exploration and deployment pointers.
Wire health checks and analytics after deploy.
Common auth and database fixes.
Core checks green? Explore features with Welcome or open the admin analytics path once you have an admin account (Monitoring).
Confirms list pages and discovery caches are wired.
If auth and one CRUD flow work but push notifications or wallet are not configured yet, you still have a valid dev clone. Add FCM and PaymentConductor before production checkout (Environment).
DB_* vars.AUTH_SECRET and OAuth redirect URIs (http://localhost:3000/api/auth/callback/google).Expect Next.js ready on http://localhost:3000. Custom server.ts may log native WSS when RING_DEPLOY_TARGET=self-hosted.
Real shape (app/api/health/route.ts): status is healthy | degraded | unhealthy (not "ok"). services.database is postgresql or firebase. Missing AUTH_SECRET → degraded and HTTP 503.
Expect 200. Open in browser; check console for red errors (ignore dev-only Auth.js JWT noise documented in lib/logger.ts filters).
/login (locale prefix may apply: /en/login).auth.ts: Google OAuth, Apple, Ring Mailer (OTP / magic link), Google One Tap, or crypto wallet — not GitHub/Discord (not in default provider list)./profile shows user data; refresh persists session.Optional: GET /api/auth/session with browser cookies returns { user: { id, email, role, … } }.
Expect count ≥ 1 after first sign-in. No /api/test-db route in this tree — use psql or authenticated API calls.
/api/entities and /api/opportunities require a session — 401 without cookies is expected.
After browser login, DevTools → copy session cookie, or test in UI:
/entities — list + create entity form submits./opportunities — list loads for your role.Expect "ready" and provider list from lib/tunnel/config. For live SSE: Network tab → /api/tunnel/sse after sign-in. See Tunnel protocol.
| Check | Command / action | Expected |
|---|---|---|
| TypeScript | npm run type-check | Exit 0 |
| Wallet API | GET /api/wallet/balance (logged in) | { balance } or 404 until wallet created |
| Build | npm run build | Completes (runs type-check by default) |
Confirms list pages and discovery caches are wired.
If auth and one CRUD flow work but push notifications or wallet are not configured yet, you still have a valid dev clone. Add FCM and PaymentConductor before production checkout (Environment).
DB_* vars.AUTH_SECRET and OAuth redirect URIs (http://localhost:3000/api/auth/callback/google).Expect Next.js ready on http://localhost:3000. Custom server.ts may log native WSS when RING_DEPLOY_TARGET=self-hosted.
Real shape (app/api/health/route.ts): status is healthy | degraded | unhealthy (not "ok"). services.database is postgresql or firebase. Missing AUTH_SECRET → degraded and HTTP 503.
Expect 200. Open in browser; check console for red errors (ignore dev-only Auth.js JWT noise documented in lib/logger.ts filters).
/login (locale prefix may apply: /en/login).auth.ts: Google OAuth, Apple, Ring Mailer (OTP / magic link), Google One Tap, or crypto wallet — not GitHub/Discord (not in default provider list)./profile shows user data; refresh persists session.Optional: GET /api/auth/session with browser cookies returns { user: { id, email, role, … } }.
Expect count ≥ 1 after first sign-in. No /api/test-db route in this tree — use psql or authenticated API calls.
/api/entities and /api/opportunities require a session — 401 without cookies is expected.
After browser login, DevTools → copy session cookie, or test in UI:
/entities — list + create entity form submits./opportunities — list loads for your role.Expect "ready" and provider list from lib/tunnel/config. For live SSE: Network tab → /api/tunnel/sse after sign-in. See Tunnel protocol.
| Check | Command / action | Expected |
|---|---|---|
| TypeScript | npm run type-check | Exit 0 |
| Wallet API | GET /api/wallet/balance (logged in) | { balance } or 404 until wallet created |
| Build | npm run build | Completes (runs type-check by default) |
Confirms list pages and discovery caches are wired.
If auth and one CRUD flow work but push notifications or wallet are not configured yet, you still have a valid dev clone. Add FCM and PaymentConductor before production checkout (Environment).
DB_* vars.AUTH_SECRET and OAuth redirect URIs (http://localhost:3000/api/auth/callback/google).Expect Next.js ready on http://localhost:3000. Custom server.ts may log native WSS when RING_DEPLOY_TARGET=self-hosted.
Real shape (app/api/health/route.ts): status is healthy | degraded | unhealthy (not "ok"). services.database is postgresql or firebase. Missing AUTH_SECRET → degraded and HTTP 503.
Expect 200. Open in browser; check console for red errors (ignore dev-only Auth.js JWT noise documented in lib/logger.ts filters).
/login (locale prefix may apply: /en/login).auth.ts: Google OAuth, Apple, Ring Mailer (OTP / magic link), Google One Tap, or crypto wallet — not GitHub/Discord (not in default provider list)./profile shows user data; refresh persists session.Optional: GET /api/auth/session with browser cookies returns { user: { id, email, role, … } }.
Expect count ≥ 1 after first sign-in. No /api/test-db route in this tree — use psql or authenticated API calls.
/api/entities and /api/opportunities require a session — 401 without cookies is expected.
After browser login, DevTools → copy session cookie, or test in UI:
/entities — list + create entity form submits./opportunities — list loads for your role.Expect "ready" and provider list from lib/tunnel/config. For live SSE: Network tab → /api/tunnel/sse after sign-in. See Tunnel protocol.
| Check | Command / action | Expected |
|---|---|---|
| TypeScript | npm run type-check | Exit 0 |
| Wallet API | GET /api/wallet/balance (logged in) | { balance } or 404 until wallet created |
| Build | npm run build | Completes (runs type-check by default) |