geldata / geldata/gel-examples

Propose functionality examples

Open
#97 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
69
Forks
25
PR merge metrics
No merged PRs in 30d

Description

## Introduction
The repository currently focuses on providing examples for frameworks in Python and TypeScript. However, developers have to rely on sections of the documentation and their client library of choice for usage. Developers may find it easier to look through existing examples for a more technical explanation as to how to bring EdgeDB forth into their applications.

## Motive
The idea behind this proposal is to visually exemplify specific implementations of EdgeDB, such as Standard Library types and using EdgeQL. Some client libraries such as [.NET](https://github.com/quinchs/EdgeDB.Net) and [JS/TS](https://github.com/edgedb/edgedb-js) feature query builders that also use helper methods and special paradigms which may be preferred by developers instead.

The objectivity of a PR resolving this Issue is to simply give examples of pure code—not documentation—so client libraries may be representable from the lens of a developer without having to immediately jump to reading docs.

## Target
The following client libraries (including community-made, unofficial ones) we want to write examples for are:

- [ ] [Python](https://github.com/edgedb/edgedb-python)
- [ ] [JavaScript/TypeScript](https://github.com/edgedb/edgedb-js)
- [ ] [Rust](https://github.com/edgedb/edgedb-rust)
- [x] [Go](https://github.com/edgedb/edgedb-go) (pending on #93)
- [ ] [.NET](https://github.com/quinchs/EdgeDB.Net)
- [ ] [Elixir](https://github.com/nsidnev/edgedb-elixir)

## Footernote
This Issue is focused on functionality of a client library and not using a framework. PRs aiming to showcase how to use clients with a framework are not to be considered as part of this Issue.

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.