electric-sql / electric-sql/examples

Add `.devcontainer` config for quickstart

Open
#25 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
34
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Hey there,

I'm not sure if this is the right place to open a feature request for the [quickstart template](https://electric-sql.com/docs/quickstart?setup=generator), but it would be awesome if you added an optional devcontainer configuration for the quickstart. For folks interested/willing to use the devcontainer config, getting started would be a simple as
1. `npx create-electric-app@latest my-app`
2. Open `my-app` in vscode
3. Respond to vscode prompt to "reopen in devcontainer"
4. `yarn start`

For my own purposes, I created a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) config for the quickstart which [you can find here](https://github.com/jorroll/electric-sql-quickstart). I also added `pg-admin` to the devcontainer, so someone can open their browser to `http://localhost:5051` to access pgadmin and see their quickstart pg databases.

I don't expect you'll want to use the setup exactly as I have it in my [example repo](https://github.com/jorroll/electric-sql-quickstart), as I made some small changes just to get things working that make it so that I don't think the quickstart would work outside of the devcontainer (e.g. `/db/util.js` -> `fetchAppName()` now just grabs the appName env variable, which is present in the devcontainer but might not be outside of the devcontainer). But hopefully all the heavy lifting has been done for you in case you are interested in adding a devcontainer. E.g. create a new vanilla quickstart folder and diff the output vs my example repo to see the relevant changes.

Another benefit of adding the devcontainer which I haven't tested, but theoretically [Github Codespaces](https://github.com/features/codespaces) should "just work" if someone opens my example repo in a new Codespace--no downloading locally required.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.