Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs and DX improvements #6

Merged
merged 20 commits into from
Jul 30, 2024
Merged

Docs and DX improvements #6

merged 20 commits into from
Jul 30, 2024

Conversation

chapati23
Copy link
Collaborator

@chapati23 chapati23 commented Jul 24, 2024 •
edited by nvtaveras
Loading

Done

  • Added npm run generate:env command that uses terraform to auto-generate a local .env file
  • Updated and improved README
  • Made shell scripts reusable across projects and more robust overall
  • Some smaller tidying

How to review

  • Check out this branch locally: git checkout chore/docs-and-dx-improvements
  • Rename your current local .env: mv .env .env.backup
  • Try out the new script npm run generate:env
  • See that it generated a fresh new local .env with the right values (hopefully 🤞)

@chapati23 chapati23 mentioned this pull request Jul 25, 2024
Merged
@nvtaveras nvtaveras self-assigned this Jul 29, 2024
nvtaveras
nvtaveras approved these changes Jul 30, 2024
View reviewed changes
Copy link
Contributor

@nvtaveras nvtaveras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went through the steps in the PR description and did a full setup/deployment from a freshly cloned repo ✅

@nvtaveras nvtaveras merged commit 6e7a988 into main Jul 30, 2024
1 check passed
@nvtaveras nvtaveras deleted the chore/docs-and-dx-improvements branch July 30, 2024 00:55
chapati23 added a commit that referenced this pull request Aug 6, 2024
@chapati23
feat: better docs and DX improvements (#6)
c7884ce
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nvtaveras nvtaveras nvtaveras approved these changes

Assignees

@nvtaveras nvtaveras

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@chapati23 @nvtaveras