graphile / graphile/graphile.github.io
Website TODO list
- Dominant language
- SCSS
- Stars
- 27
- Forks
- 126
- PR merge metrics
- No merged PRs in 30d
Description
BENJIE'S NOTE: this post was originally written by @calebmer on the PostGraphQL repo (since renamed to PostGraphile); since then we have built a website (https://graphile.org) but many of these points are still salient so we'll keep this issue open until they're dealt with.
~~PostGraphQL needs a documentation/marketing website. As a frontend engineer I’d love to build it myself, but at the same time PostGraphQL needs improvements in areas like performance. Here is an outline for what I want in the site (of course these specifications are subject to change):~~
- [x] An attractive landing page.
- [ ] An easily accessible GraphiQL interface (this will probably need to be hosted on Heroku).
- [ ] A super basic getting started article.
- [x] Forum example tutorial.
- [ ] Helpful articles:
- [x] Example Queries.
- [ ] Documenting your schema (with Postgres `COMMENT`).
- [ ] Deploying PostGraphQL with Docker.
- [ ] Deploying PostGraphQL with PM2.
- [ ] Extending your database with triggers and `LISTEN`/`NOTIFY`.
- [ ] Writing JavaScript or Ruby in your Postgres logic.
- [ ] Understanding graph database terms in GraphQL.
- [ ] Backing up your Postgres database.
- [ ] Why you should use PostGraphQL (persuasive, stop overengineering, etc.)
- [ ] Documentation.
…and here’s a quick outline for documentation:
- [ ] Tables.
- [ ] Queries.
- [ ] Relationships.
- [ ] Unique keys.
- [ ] Mutations.
- [ ] Procuedures.
- [ ] Mutations.
- [ ] Queries.
- [ ] Connections.
- [ ] Computed fields.
- [ ] Custom types.
- [ ] Domain types.
- [ ] Enum types.
- [ ] Composite types.
- [ ] Authentication/Authorization.
- [x] PostGraphQL as a CLI tool.
- [ ] PostGraphQL as HTTP middleware, basic examples of the web techs would be awesome:
- [ ] `http`
- [ ] `express`
- [ ] `connect`
- [ ] `koa`
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.