Skip to content

docs(web): add getting-started README for frontier/web#1673

Open
paanSinghCoder wants to merge 1 commit into
mainfrom
docs/web-getting-started
Open

docs(web): add getting-started README for frontier/web#1673
paanSinghCoder wants to merge 1 commit into
mainfrom
docs/web-getting-started

Conversation

@paanSinghCoder
Copy link
Copy Markdown
Contributor

What

Adds a getting-started README at web/README.md for the Frontier web monorepo, and links to it from the root README.

Details

web/README.md covers:

  • What's insideapps/admin, apps/client-demo, the @raystack/frontier SDK, and shared tools/* configs
  • Prerequisites — Node >= 22, pnpm >= 10.19.0
  • Getting startedpnpm install, pnpm dev, Turbo filters, and per-package commands
  • Backend config — the .env files each app needs, with localhost values (REST on :8000, ConnectRPC on :8002)
  • Common scripts and Makefile shortcuts

Root README.md now links to it under a new Web subsection in Usage.

Docs only — no code changes.

Add a getting-started guide for the web monorepo (apps/admin,
apps/client-demo, the @raystack/frontier SDK, and shared tools), covering
prerequisites, install, dev servers, and per-app .env backend config.
Link to it from the root README under Usage.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
frontier Ready Ready Preview, Comment Jun 3, 2026 11:41am

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6eaca45c-35aa-4607-9181-e2fc1ed4dcc7

📥 Commits

Reviewing files that changed from the base of the PR and between c2f9a2c and e02d197.

📒 Files selected for processing (2)
  • README.md
  • web/README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated main README with web frontend information and reference to detailed documentation.
    • Added comprehensive web frontend monorepo documentation covering setup, development commands, and available scripts.

Walkthrough

Root README is updated to point users to web frontend documentation, and web/README.md is replaced with comprehensive setup instructions, workspace structure details, development workflows, environment configuration, and available scripts for the web frontend monorepo.

Changes

Web Frontend Documentation

Layer / File(s) Summary
Web frontend documentation and navigation
README.md, web/README.md
Root README adds a "Web" subsection under Usage directing readers to the web frontend workspace at web/README.md. The web/README.md file is entirely replaced with documentation covering pnpm/Turborepo workspace structure, included packages (admin app, client demo, SDK, shared tooling), Node.js and pnpm version prerequisites, getting started and development commands, per-app .env backend configuration, common scripts and Makefile shortcuts, and links to additional documentation and SDK resources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coveralls
Copy link
Copy Markdown

Coverage Report for CI Build 26882374285

Coverage remained the same at 43.153%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 38000
Covered Lines: 16398
Line Coverage: 43.15%
Coverage Strength: 12.09 hits per line

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants