https://github.com/phated/twentyfive-stars
(On-Hold until they fix Context) GraphQL server written in Rust.
https://github.com/phated/twentyfive-stars
Last synced: 4 months ago
JSON representation
(On-Hold until they fix Context) GraphQL server written in Rust.
- Host: GitHub
- URL: https://github.com/phated/twentyfive-stars
- Owner: phated
- License: mpl-2.0
- Created: 2019-12-25T06:34:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-14T04:00:41.000Z (about 5 years ago)
- Last Synced: 2025-07-19T04:42:17.009Z (6 months ago)
- Language: Rust
- Homepage:
- Size: 1.87 MB
- Stars: 71
- Watchers: 3
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - twentyfive-stars - Hold until they fix Context) GraphQL server written in Rust. | phated | 72 | (Rust)
README
# twentyfive-stars
(Work-in-progress) GraphQL server written in Rust.
## About
This project aims to provide a [Relay-compliant GraphQL server](https://relay.dev/docs/en/graphql-server-specification) that models all cards in the [Transformers Trading Card Game](https://transformerstcg.hasbro.com/en-us) as well-defined entities.
The Transformers TCG is an interesting thing to model because the game is still fairly new, yet is very dynamic due to the different types of cards and the variations of data they provide.
## Technologies
This list is likely to change as I explore and improve on this project:
__Server:__
* [rust](https://www.rust-lang.org)!
* [async-graphql](https://github.com/async-graphql/async-graphql)
* [sqlx](https://github.com/launchbadge/sqlx) - custom fork for my user-defined types right now
* [tide](https://github.com/launchbadge/sqlx)
* [postgres](https://www.postgresql.org)
__Client:__
* [ReasonML](https://reasonml.github.io)
* [Reason-Relay](https://reason-relay-documentation.zth.now.sh)
* [Reason-React](https://reasonml.github.io/reason-react/)
## Prerequisite: Auth0
This project uses [Auth0](https://auth0.com) for OAuth2 authentication and JWT creation/validation.
Please follow our [Setting up Auth0](./docs/setting-up-auth0.md) guide before trying to set up the server.
## Setting up the server
You'll need the Rust toolchain and Postgres installed on your computer.
1. Make sure you have Postgres running and copy the `.env.example` to `.env` with the `DATABASE_URL` pointing to your local database.
1. Install the `cargo sqlx` command using `cargo install --git git://github.com/phated/sqlx --branch custom-types-040 sqlx-cli`
1. Create the database using `cargo sqlx database create`
1. Migrate the new database using `cargo sqlx migrate run`
1. Build and start the server with `cargo run`
## Seeding the database
You'll need Node.js and Yarn installed on your computer.
1. Get the JWT from a logged in GraphiQL session, by navigating to `localhost:3000/login` and then grabbing the token after "Bearer" under "HTTP Headers" once redirected to the GraphiQL interface.
1. Add the token to your `.env` file as `AUTH_TOKEN`
1. Fetch the Node dependencies using `yarn` command
1. Then seed the database with `yarn seed`
## Testing out the data
You can test the newly seeded data with the built-in playground.
Open your browser to `localhost:3000` and start exploring the schema and issuing requests!
Here is an example of a valid query (with full `Relay` support) that you can send to this server.
```graphql
query {
allCards {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
... on Node {
id
}
... on Card {
tcgId
rarity
number
category
wave {
... on Node {
id
}
tcgId
name
released
}
}
... on CharacterCard {
modes {
title
faction
stars
type
... on AltMode {
subtitle
traits
health
attack
defense
}
... on BotMode {
subtitle
traits
health
attack
defense
}
}
}
... on BattleCard {
title
stars
faction
icons
attackModifier
defenseModifier
}
}
}
}
}
```
## License
[MPL-2.0](./LICENSE)