graphile / graphile/graphile.github.io

Postgraphile Sandbox/Playground

Offen
#273 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
SCSS
Sterne
27
Forks
126
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### Feature description

Make a new repo with a [Deploy to Heroku button](https://devcenter.heroku.com/articles/heroku-button) for easily playing around with postgraphile without having to install anything or do toilsome setup.

It should come with postgres, pgadmin and postgraphile installed and running within a docker container, probably with one or more example databases installed.

It should be running with a variety of recommended plugins and settings for development, like `--enhance-graphiql` and `--allow-explain`.

By default, it should run the CLI, but it should also have a JS-driven example included with a easy switch to use that, so you can fork, write a custom plugin, and deploy with a click.

(Note that it should not use heroku's built-in postgres because it doesn't allow CREATE ROLE and could get expensive if a malicious actor spotted a free, world-configurable database).

Inspired by [this discussion](https://github.com/graphile/persisted-operations/issues/6#issuecomment-822695546)

### Motivating example

1. Have one official playground running that prospective users can play with, to see what postgraphile is like in the wild. (This should probably be completely cleared and rebooted at regular intervals, perhaps with a bit of automation from the heroku api and a stable subdomain).
2. Allow postgraphile users to quickly spin up their own playgrounds to explore prototyping concepts.
3. Allow postgraphile users to to demonstrate a minimal repro case for a bug or issue by running DDL, inserting data, and running a gql query.

### Breaking changes

None

### Supporting development

I intend to build this myself over the next week or two, but who knows life happens sometimes, so I wanted to file as an issue in case I don't get to it and someone else wants to come along and build it.

I [tick all that apply]:

- [x] am interested in building this feature myself
- [ ] am interested in collaborating on building this feature
- [x] am willing to help testing this feature before it's released
- [ ] am willing to write a test-driven test suite for this feature (before it exists)
- [x] am a [Graphile sponsor](https://www.graphile.org/sponsor/) ❤️
- [ ] have an active [support or consultancy contract](https://www.graphile.org/support/) with Graphile

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Start by reviewing the Heroku Button documentation and the proposed Docker-based setup described in the issue, including the PostGraphile CLI and JavaScript examples. Done means a new repository can deploy a working playground with Postgres, pgAdmin, PostGraphile, example data, recommended development settings, and a way to switch to the JavaScript example.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
docker, graphql, javascript, postgres
Bereich
backend-api-design, databases, developer-experience, devops
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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