docs: expand README with setup, testing, and architecture guides - #141
Open
Erij-Maherzia-BEN-BRAHIM wants to merge 1 commit into
Open
docs: expand README with setup, testing, and architecture guides#141Erij-Maherzia-BEN-BRAHIM wants to merge 1 commit into
Erij-Maherzia-BEN-BRAHIM wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expands the admin panel README to improve onboarding for new contributors and developers evaluating the project.
Motivation: The previous README assumed a running LibreChat instance and only documented a minimal
bun install && bun devflow. It did not explain the BFF → Admin API architecture, Node.js version requirements, how to explore the UI without credentials, available npm scripts, or how to run tests.Changes:
ADMIN_PANEL_METRICS_SECRETto the env var tableNo code behavior changes in this PR.
Change Type
Please delete any irrelevant options.
Testing
Docs-only change. Verified manually:
package.json,playwright.config.ts, ande2e/mock-backend.mjsVITE_API_BASE_URL=http://localhost:3081)Test Configuration:
Checklist
Please delete any irrelevant options.