Add `.devcontainer` config for quickstart
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript, vscode
- Domain
- developer-experience, tooling
Research direction
Start by generating a vanilla quickstart and diff it against the linked electric-sql-quickstart example, focusing on the proposed .devcontainer configuration and /db/util.js. Verify that the generated app can be reopened in a devcontainer and started with yarn start; the optional configuration should also preserve the quickstart's normal behavior outside the container.
Written by the indexing model from the issue text.
Description
Hey there,
I'm not sure if this is the right place to open a feature request for the quickstart template, 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
npx create-electric-app@latest my-app- Open
my-appin vscode - Respond to vscode prompt to "reopen in devcontainer"
yarn start
For my own purposes, I created a devcontainer config for the quickstart which you can find here. 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, 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 should "just work" if someone opens my example repo in a new Codespace--no downloading locally required.
- Dominant language
- JavaScript
- Stars
- 34
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from electric-sql/examples
-
Expo example error Open
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
electric-sql/examples#26 ·
All issues in electric-sql/examples
Similar issues
-
bug confirmed issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
open-webui/open-webui#30750 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Mend: dependency security vulnerability untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 70/100