docs: add backend API setup guide for Verilog and backend features#827
docs: add backend API setup guide for Verilog and backend features#827Me-Priyank wants to merge 6 commits intoCircuitVerse:mainfrom
Conversation
✅ Deploy Preview for circuitverse ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughAdds a new .env.example exposing VITE_API_URL options (production active, local and staging commented), adds .env to .gitignore, updates vite.config.ts to use loadEnv(mode, ...) and make the config mode-aware, adds a '/api' dev-server proxy using env.VITE_API_URL with a http://localhost:3000 fallback, and adds a "Backend API Setup" section to README.md documenting required endpoints and local/production setup steps. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @.env.example:
- Line 9: The .env.example file is missing a trailing newline which fails
dotenv-linter; open the .env.example and add a single newline character at the
end of the file (i.e., ensure the last line "#
VITE_API_URL=https://staging.circuitverse.org" is followed by a newline) so the
file ends with a newline.
🧹 Nitpick comments (3)
README.md (1)
45-115: Consider adding a concise backend endpoint list.
This section explains how to configure the backend, but not which endpoints are required. A short list/table would make the setup self‑contained and reduce guesswork.📝 Suggested addition
+### Required Backend Endpoints +| Feature | Endpoint | +| --- | --- | +| Verilog compilation | /api/v1/simulator/verilogcv | +| Project save/load | /api/v1/projects/* | +| Authentication & user info | /api/v1/auth/*, /api/v1/me | +| Project permissions | /api/v1/projects/:id/check_edit_access | +| Issue reporting | /api/v1/simulator/post_issue |.env.example (1)
4-7: Safer default: avoid auto-targeting production.
Copying.env.examplecurrently points to production by default. Consider leaving production commented to prevent accidental writes.🛡️ Proposed tweak
- VITE_API_URL=https://circuitverse.org + # VITE_API_URL=https://circuitverse.orgvite.config.ts (1)
2-16: ScopeloadEnvtoVITE_(and optionally reuse for other VITE vars).
loadEnv(..., '')pulls in all env keys. Scoping toVITE_reduces accidental loading and lets.envdrive VITE_* values consistently.♻️ Suggested refactor
-export default defineConfig(({ mode }) => { - const env = loadEnv(mode, process.cwd(), '') - const version = process.env.VITE_SIM_VERSION || 'v0' +export default defineConfig(({ mode }) => { + const env = loadEnv(mode, process.cwd(), 'VITE_') + const version = env.VITE_SIM_VERSION || process.env.VITE_SIM_VERSION || 'v0' ... - base: process.env.VITE_BASE || (isDesktop ? '/' : `/simulatorvue/${version}/`), + base: env.VITE_BASE || process.env.VITE_BASE || (isDesktop ? '/' : `/simulatorvue/${version}/`),
Me-Priyank
force-pushed
the
docs/backend-api-setup
branch
from
23a5e68 to
8222545
Compare
|
@Nihal4777 @tachyons kindly review. Happy to make any changes (if needed) or adjust the approach based on your suggestions |
Me-Priyank
force-pushed
the
docs/backend-api-setup
branch
from
10aeaa7 to
46f20b4
Compare
|
Updated the PR @Nihal4777 , thanks for the suggestion :) |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 49-55: Update the "Backend-Dependent Features" section in
README.md to include an explicit list of the ~12 required backend API endpoints
(as requested by issue `#826`) instead of only feature areas; locate the
"Backend-Dependent Features" heading and add a clear, enumerated endpoints list
(e.g., auth/login, auth/register, projects/create, projects/get,
projects/update, projects/delete, projects/permissions, files/upload,
files/download, compile/verilog, issues/report, health/status) and mirror the
same detailed endpoint list in the other instance of that documentation block
(lines referenced in the comment) so both sections contain the identical
required endpoint names and brief purpose descriptions.
🧹 Nitpick comments (1)
README.md (1)
63-74: Clarify thatVITE_API_URLmust be the backend origin (no/api).Given the Vite proxy prepends
/api, users might setVITE_API_URL=https://circuitverse.org/apiand end up with/api/api. Add a one-line clarification to prevent misconfiguration.✏️ Suggested doc tweak
-2. **Choose your backend option** (edit `.env`): +2. **Choose your backend option** (edit `.env`, set the backend **origin only**, no `/api`):
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 56-71: The README's endpoint tables (headers like "| Endpoint |
Purpose |" and rows such as "`POST /auth/login`", "`GET /projects/:id`", etc.)
violate markdownlint rules MD058/MD060; add a blank line before and after each
table and ensure each table cell has single-space padding around pipes (e.g., "|
POST /auth/login | User authentication |") for both the table at the shown block
and the second table around the 129-144 region so markdownlint no longer flags
missing blank lines or compact pipe spacing.
- Around line 56-70: The README's endpoint table lists routes without the API
prefix (e.g., `POST /auth/login`, `GET /projects/:id`) while the codebase uses
`/api/v1/...`; update every route in the table to include the `/api/v1/` prefix
(e.g., `/api/v1/auth/login`, `/api/v1/projects/:id`) and ensure verbs and path
parameters remain unchanged, and remove the duplicated endpoint table (the
second instance of the same list) so only a single consolidated table remains to
avoid maintenance drift.
🧹 Nitpick comments (1)
README.md (1)
99-143: Avoid duplicating the endpoint table to prevent drift.The same “Required API Endpoints (~12)” table appears twice. Consider keeping a single table and referencing it from the second section (e.g., “See endpoint list above”) to reduce maintenance risk.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 56-71: Update the API endpoints table in README.md so it matches
the real backend routes and HTTP verbs used in the codebase: replace listed
entries that differ (e.g., change POST /api/v1/compile/verilog to POST
/api/v1/simulator/verilogcv, POST /api/v1/issues/report to POST
/api/v1/simulator/post_issue, and POST /api/v1/auth/register to POST
/api/v1/auth/signup), change the project update verb from PUT to PATCH for the
projects update endpoint, add missing routes used in code such as GET
/api/v1/me, POST /api/v1/projects/update_circuit, GET
/api/v1/projects/:id/circuit_data, GET /api/v1/projects/:id/check_edit_access,
and remove or mark as undocumented any endpoints that are not actually
implemented (or verify existence of /api/v1/files/upload,
/api/v1/files/download/:id, /api/v1/health/status,
/api/v1/projects/:id/permissions, DELETE /api/v1/projects/:id) so the table
exactly reflects the backend contract.
Me-Priyank
force-pushed
the
docs/backend-api-setup
branch
from
3851f8d to
cb21bcb
Compare
|
done @Nihal4777 |
|
@Nihal4777 can you please review |
|
@tachyons PTAL |
2 participants
Fixes #826
Describe the changes you have made in this PR -
This PR adds comprehensive backend API setup documentation to help new contributors configure the development environment for backend-dependent features (Verilog compilation, Save/Load, Authentication, etc.).
Changes Made:
✅ Added
.env.exampletemplate with clear backend configuration options✅ Added "Backend API Setup" section to
README.md(72 lines)✅ Enhanced
vite.config.tsproxy with environment variable support and logging✅ Updated
.gitignoreto prevent committing.envsecretsImpact:
Screenshots of the UI changes (If any) -
Verilog working:
Screen.Recording.2026-01-19.223303.mp4
Auth working:
Screen.Recording.2026-01-19.224906.mp4
Code Understanding and AI Usage
Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?
If you used AI assistance:
Explain your implementation approach:
Why This Implementation:
.envfiles (industry standard for configuration).env.examplevite.config.tsstructure (proxy already existed!)Alternative Approaches Considered:
How It Works:
.env.exampleto.env.env/api/*requests to configured backendTesting:
.envis gitignoredChecklist before requesting a review
Note: Please check Allow edits from maintainers if you would like us to assist in the PR.
Summary by CodeRabbit
Documentation
New Features
Chores
✏️ Tip: You can customize this high-level summary in your review settings.