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.

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

Docs: Add ez-pg script #895

Merged
merged 2 commits into from
Feb 13, 2025
Merged

Conversation

robertjdominguez
Copy link
Collaborator

Description 📝

Adds a script for easily spinning up the how-to tutorial for PostgreSQL. Any of us with the hasura/ddn-docs repo can simply run the following from the docs repo:

yarn quicky:pg --P="<name-of-new-project-dir>"

This will:

  • Generate the necessary directory
  • Scaffold out a DDN project with the PG connector
  • Add the SQL (users and posts) from the tutorial
  • Add all resources as HML metadata
  • Generate a build
  • Modify the .hasura/context.yaml because I hate the logs
  • Start things up
  • Open the local console

All you have to do is come up with a clever name + hit RETURN twice 🤙

Demo:

https://screen.studio/share/pTKXXdFJ

NB: This can be expanded to work with other connectors for easy spin-up of local testing environments when helping users, writing docs, etc.

Adds a script for easily spinning up the how-to dataset for PostgreSQL.
@hasura-bot
Copy link
Contributor

@robertjdominguez Thanks for your PR! I've assigned @seanparkross to review it.

Copy link

cloudflare-workers-and-pages bot commented Feb 13, 2025

Deploying ddn-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: bf42956
Status:⚡️  Build in progress...

View logs

@robertjdominguez robertjdominguez enabled auto-merge (squash) February 13, 2025 20:43
@robertjdominguez robertjdominguez merged commit 1135863 into main Feb 13, 2025
2 of 4 checks passed
@robertjdominguez robertjdominguez deleted the rob/utils/add-pg-starter-script branch February 13, 2025 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants