Add comprehensive deployment documentation with advanced version management to README #98
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.
This PR adds detailed deployment documentation to the project README, explaining how the automated deployment process works for the Glowing Telegram Frontend, including both comprehensive setup instructions and advanced version management capabilities.
Changes Made
Added a new "Deployment" section to README.md that covers:
How to Deploy
Prerequisites
AWS_REGION
,AWS_ROLE_ARN
,BUCKET_NAME
)COGNITO_CLIENT_ID
,COGNITO_USER_POOL_ID
,COGNITO_DOMAIN
)API_URL
,WEBSOCKET_URL
,CONTENT_URL
)TWITCH_CLIENT_ID
)LOGOUT_URI
,REDIRECT_URI
)Deployment Process
Frontend Version Management
config/version.json
fileRelease Versioning
s3://bucket-name/release-version/
)Local Build Testing
npm run build
andnpm run serve
Workflow Enhancements
The PR also includes merged workflow improvements from main:
rollbackVersion
input parameter topublish.yml
The documentation is strategically positioned between the Project Structure and Contributing sections, maintaining the README's logical flow while providing essential deployment information for maintainers and contributors.
Fixes #97.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.