docs: improve backend README with Kubernetes setup, troubleshooting, and fixes. #1782
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
…and fixes - Added Kubernetes deployment steps for local development. - Fixed incorrect commands in setup and testing sections. - Included additional troubleshooting guidance for common issues. - Improved readability and structure of the README for easier navigation. - Updated formatting to align with GitHub Markdown best practices. Signed-off-by: Pranali Deshmukh <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1782 +/- ##
=======================================
Coverage 99.85% 99.85%
=======================================
Files 175 175
Lines 6832 6832
Branches 1303 1311 +8
=======================================
Hits 6822 6822
Misses 10 10 🚀 New features to boost your workflow:
|
jbair06
requested changes
Sep 4, 2025
jbair06
reviewed
Sep 15, 2025
jbair06
reviewed
Sep 15, 2025
jbair06
reviewed
Sep 16, 2025
- Removed outdated E2E testing section - Corrected various typos. - Updated Testing section to focus on Unit/Integration. - Standardised URLs and endpoint formatting Signed-off-by: Pranali Deshmukh <[email protected]>
jbair06
previously approved these changes
Dec 10, 2025
Updated instructions for creating a Brevo account and modified deployment command. Signed-off-by: Pranali Deshmukh <[email protected]>
Signed-off-by: John Bair <[email protected]>
jbair06
approved these changes
Jan 13, 2026
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.
Description:
Related issue(s):
Fixes #1781
Notes for reviewer:
Kubernetes steps and troubleshooting guidance have been reviewed and confirmed with John.
Checklist