docs: update getting started for current OpenTofu layout#44
Open
dmeiser wants to merge 1 commit into
Open
Conversation
- Pin Python to 3.14 and Node.js to 20 to match pyproject.toml and CI. - Expand the AWS permissions list to include IAM, ACM, Route 53, CloudFront, Lambda, SNS, and CloudWatch/Billing. - Correct all OpenTofu paths from tofu/environments/* to tofu/application/environments/*. - Clarify that .env lives at the repo root and must set TF_VAR_encryption_passphrase. - Add bootstrap instructions for the OpenTofu state bucket. - Add frontend build/deploy section using tofu output values. - Warn that dev enables Google IdP/WebAuthn by default and requires credentials or explicit disabling. - Update Next Steps to remove stale CDK reference and include testing, catalog creation, and test-user setup.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s onboarding documentation to reflect the current OpenTofu-based infrastructure layout and updated tooling versions, so new contributors can bootstrap and deploy using the repo’s current structure.
Changes:
- Updates documented runtime/tooling prerequisites (Python 3.14, Node.js 20, OpenTofu >= 1.7.0, AWS CLI v2).
- Fixes OpenTofu environment paths to
tofu/application/environments/{env}in README and Getting Started. - Adds state-bucket bootstrap guidance and expands deployment instructions (including frontend deploy steps).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Updates backend Python runtime and corrects the OpenTofu environment path used in deployment docs. |
| docs/GETTING_STARTED.md | Refreshes prerequisites and deployment flow to match current OpenTofu layout, adds bootstrap + frontend deployment guidance. |
Comment on lines
273
to
+277
| Key outputs include: | ||
| - **UserPoolId**: Cognito User Pool ID | ||
| - **UserPoolClientId**: App client ID for authentication | ||
| - **ApiEndpoint**: AppSync GraphQL API endpoint | ||
| - **TableName**: DynamoDB table name | ||
| - **StaticAssetsBucket**: S3 bucket for SPA hosting | ||
| - **ExportsBucket**: S3 bucket for generated reports | ||
| - **cognito_user_pool_id**: Cognito User Pool ID | ||
| - **cognito_client_id**: App client ID for authentication | ||
| - **appsync_api_url**: AppSync GraphQL API endpoint | ||
| - **dynamodb_table_name**: DynamoDB table name |
| npm run build | ||
|
|
||
| # Upload to S3 | ||
| aws s3 sync dist s3://$(tofu -chdir=../tofu/application/environments/dev output -raw static_assets_bucket) --delete |
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.
Updates
docs/GETTING_STARTED.mdandREADME.mdto match the current project layout and tooling:tofu/application/environments/dev).envwithTF_VAR_encryption_passphrasetofu inittofu output