https://github.com/addono/graphql-yoga-ts-example
A toy example of a GraphQL server written in TypeScript.
https://github.com/addono/graphql-yoga-ts-example
Last synced: 3 months ago
JSON representation
A toy example of a GraphQL server written in TypeScript.
- Host: GitHub
- URL: https://github.com/addono/graphql-yoga-ts-example
- Owner: Addono
- License: mit
- Created: 2020-11-04T08:24:27.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T15:23:39.000Z (almost 3 years ago)
- Last Synced: 2024-12-27T00:27:26.768Z (about 1 year ago)
- Language: TypeScript
- Size: 322 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Test pipeline][test-pipeline-shield]][test-pipeline-url]
GraphQL-Yoga + TypeScript Example
A toy example of a GraphQL server written in TypeScript.
Report Bug
·
Request Feature
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
You need the following applications to be able to run this repo:
- Node.js
- Yarn
### Installation
1. Clone the repo
```sh
git clone https://github.com/Addono/graphql-yoga-ts-example.git
```
2. Install Yarn packages
```sh
yarn install --frozen-lockfile
```
## Usage
First, start the server:
```sh
yarn run start
```
Then you can interact with the GraphQL endpoint at http://localhost:5000.
For example, the following query will create a new user named Bob:
```graphql
mutation {
createUser(name: "Bob") {
id
name
}
}
```
And this query gets you the name and id of all registered users:
```graphql
query {
users {
name
id
}
}
```
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
[contributors-shield]: https://img.shields.io/github/contributors/addono/graphql-yoga-ts-example.svg?style=flat-square
[contributors-url]: https://github.com/addono/graphql-yoga-ts-example/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/addono/graphql-yoga-ts-example.svg?style=flat-square
[forks-url]: https://github.com/addono/graphql-yoga-ts-example/network/members
[stars-shield]: https://img.shields.io/github/stars/addono/graphql-yoga-ts-example.svg?style=flat-square
[stars-url]: https://github.com/addono/graphql-yoga-ts-example/stargazers
[issues-shield]: https://img.shields.io/github/issues/addono/graphql-yoga-ts-example.svg?style=flat-square
[issues-url]: https://github.com/addono/graphql-yoga-ts-example/issues
[license-shield]: https://img.shields.io/github/license/addono/graphql-yoga-ts-example.svg?style=flat-square
[license-url]: https://github.com/addono/graphql-yoga-ts-example/blob/main/LICENSE
[test-pipeline-shield]: https://img.shields.io/github/workflow/status/Addono/graphql-yoga-ts-example/Test?style=flat-square&logo=github%20actions
[test-pipeline-url]: https://github.com/Addono/graphql-yoga-ts-example/actions?query=workflow%3ATest