electric-sql / electric-sql/examples

Add `.devcontainer` config for quickstart

Offen
#25 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
34
Forks
6
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne damit, einen Vanilla-Quickstart zu generieren und einen Diff im Vergleich zum verlinkten Beispiel electric-sql-quickstart zu erstellen, wobei du dich auf die vorgeschlagene .devcontainer-Konfiguration und /db/util.js konzentrierst. Überprüfe, dass die generierte Anwendung in einem Devcontainer erneut geöffnet und mit yarn start gestartet werden kann; die optionale Konfiguration sollte außerdem das normale Verhalten des Quickstarts außerhalb des Containers beibehalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, vscode
Bereich
developer-experience, tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.