Skip to content

Add information on how to run to README #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Examples for async-graphql

A git submodule that shows example async-graphql projects.


## Directory structure

- [poem] Examples for `poem`
Expand All @@ -9,3 +12,28 @@
- [rocket] Examples for `rocket`
- [axum] Examples for `axum`
- [federation] Examples for [Apollo Federation](https://www.apollographql.com/docs/federation/)


## Running Examples

To run the examples, clone the top-level repo, [async-graphql](https://github.com/async-graphql/async-graphql) and then issue the following commands:

```bash
git clone async-graphql/async-graphql
# in async-graphql repo, install needed dependencies
cargo build

# update this repo as a git submodule
git submodule update
```

To run the example axum-starwars:
```
# change into the example folder and run a relevant binary
cargo run --bin axum-starwars
```

To list all available binary targets:
```
cargo run --bin
```