docs: expand README with environment, security, and troubleshooting - #10
Merged
Merged
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.
Motivation
dev,stage, andprodenvironments.BACKEND_BASE_URLto the app runtime configuration.Description
README.mdto add aPrerequisitessection and concrete run examples using--dart-define(e.g.APP_ENVandAPI_BASE_URL) and sampleflutter run/flutter build webcommands.BACKEND_BASE_URLmaps toAPI_BASE_URLand noted that the/api/v1prefix should be provided in theAPI_BASE_URLvalue used at build/run time and referencedEnvConfig.load()/lib/core/config/env_config.dart.DTO -> repo -> use case -> UI -> route -> test) with points where to place files and tests.Securitysection covering token storage (in-memoryTokenStoragevs web fallback risks), XSS mitigation, CSP recommendations, and token rotation / refresh flow behavior.Troubleshootingsection that lists checks and symptoms for401/refresh loops, CORS failures,429rate-limits, and network/timeouts.Testing
flutter test --reporter expanded, but theflutterbinary was not available in the environment so the command failed (command not found).flutter pub getandflutter test --reporter expandedvia.github/workflows/ci.yml, so automated tests will execute in the CI environment for the PR.Codex Task