Skip to content

Commit

Permalink
[E4E-30]: Initial commit; base repo (no functionality)
Browse files Browse the repository at this point in the history
  • Loading branch information
TheCleric committed Nov 20, 2021
0 parents commit b437b91
Show file tree
Hide file tree
Showing 9 changed files with 8,994 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
14
1 change: 1 addition & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('@encoura/eslint-config/.prettierrc');
12 changes: 12 additions & 0 deletions .versionrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"skip": {
"commit": true
},
"tagPrefix": "",
"types": [
{
"type": "",
"section": "Changes"
}
]
}
Empty file added CHANGELOG.md
Empty file.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Apollo Rest utils

Encoura's solution to integrating rest APIs with [Apollo](https://www.apollographql.com/docs/) and [Apollo Client](https://www.apollographql.com/docs/react/).

These utils build on top of the great work of [apollo-link-rest](https://www.apollographql.com/docs/react/api/link/apollo-link-rest/).

This library provides helper functions and generators for making integration with REST apis and Apollo in a TypeScript application.

## Features

* A command line utiltity that takes a swagger file/url, and automatically generates input and output types, and endpoint definitions that can be used to make integration with `apollo-link-rest` much easier.
* Wrapper functions for common GraphQL operations that allow you to pass in pure GraphQL, and enables the input variables and the result to be strongly typed based on the swagger definition.
* Automatically checks your GraphQL at runtime and will throw exceptions if your GraphQL fields do not match the endpoint definition.

## Usage

TODO

## Releasing

After making any changes and merging them to main, please do the following:
* Create a new branch from main and run `npm run update:version`
* Verify the `CHANGELOG.md` generated changes
* Commit, push, and merge to main.
* Create a new [release](https://github.com/nrccua/apollo-rest-utils/releases/new) using the tag generated in the previous steps
* Use the `Auto-generate release notes` button to generate the release notes, and add any context you may deem necessary.
2 changes: 2 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// eslint-disable-next-line import/no-extraneous-dependencies
module.exports = require('@encoura/eslint-config/commitlint.config');
Loading

0 comments on commit b437b91

Please sign in to comment.