Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dex4er/ts-node-github-api-example
Example of Github API v4 client written in Typescript with Apollo library
https://github.com/dex4er/ts-node-github-api-example
Last synced: about 2 months ago
JSON representation
Example of Github API v4 client written in Typescript with Apollo library
- Host: GitHub
- URL: https://github.com/dex4er/ts-node-github-api-example
- Owner: dex4er
- License: mit
- Created: 2019-04-29T10:06:15.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-23T17:41:48.000Z (2 months ago)
- Last Synced: 2024-10-24T20:49:53.300Z (2 months ago)
- Language: TypeScript
- Size: 115 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @dex4er/ts-node-github-api-example
[](http://travis-ci.org/dex4er/ts-node-github-api-example) [](https://gitlab.com/dex4er/ts-node-github-api-example/pipelines)
This is an example of Github API v4 client written in Typescript with Apollo library.
Additionaly this project provides a Gitlab pipeline configuration which
produces binary packages stored in artifacts repository:
## Requirements
This package requires ES6 with Node >= 8.
## Usage
In working directory:
### dependencies
```shell
yarn
```
### token
```shell
cp .env.example.sh .env
edit .env
```
### schema offline
```shell
git submodule sync
git submodule update --init
# to download the latest later:
git submodule update --remote
```
### schema online
```shell
yarn github-apiv4-get-schema
```
### schema download for offline
```shell
yarn github-apiv4-get-stubby
```
### schema to typescript
```shell
yarn codegen
```
### compile
```shell
yarn compile
```
### run offline for testing
```shell
yarn github-apiv4-viewer-query:stubby
```
### run online
```shell
yarn github-apiv4-viewer-query
```
## License
Copyright (c) 2019 Piotr Roszatycki
[MIT](https://opensource.org/licenses/MIT)