Enhance docs with DevContainer guide #84
Conversation
self-hosted/README.md
Outdated
| > [!TIP] | ||
| > **Local Development: Add Convex to Your Own DevContainer** | ||
| > | ||
| > Want to use Convex in your own project with a reproducible, containerized local development environment? | ||
| > Check out our [DevContainer guide](./devcontainer/README.md) for step-by-step instructions on how to add Convex to > your own repository using Visual Studio Code and Docker. This approach lets you spin up a fully configured Convex > backend for local development, with no manual dependency setup required. | ||
| > | ||
| > **To get started:** | ||
| > Follow the instructions in [self-hosted/devcontainer/README.md](./devcontainer/README.md) to add a DevContainer > configuration to your project and run Convex locally inside Docker. | ||
|
|
There was a problem hiding this comment.
can I ask to remove this portion for now.
Just because Convex also has a local development setup built into npx convex dev and I don't want to confuse our customers around it. I'll think about it more, but for now, let's just add the new doc in the subdirectory.
I think there's probably a good way we can shout out devcontainers in the main README as another option, but I want to try and steer away from strongly recommending it near the top until it's more battle tested over time.
There was a problem hiding this comment.
Have to navigate carefully between things that are built by / supported by Convex vs things that are more community built and supported - so I'm thinking about how to do that as well.
Love the contributions.
There was a problem hiding this comment.
I'll send a PR in the future with something for the main README and add you as a reviewer.
There was a problem hiding this comment.
Of course, I can remove it—no problem.
And if you ever decide to add a DevContainer setup for the convex-backend project itself, feel free to reach out. I’d be glad to contribute!
- Added an example DevContainer configuration for running Convex in a containerized environment. - Updated `README.md` to include a guide on integrating Convex with DevContainers for reproducible local development. - The DevContainer setup includes necessary mounts, port forwarding, and commands for easy onboarding and consistent development experience. get-convex#79
iamfj
force-pushed
the
docs-add-guide-to-use-devcontainer-env
branch
from
a81adfb to
77b21cd
Compare
|
Sorry for delay! It's in! |
README.mdto include a guide on integrating Convex with DevContainers for reproducible local development.#79