Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrien2p/nestjs-graphql
nest-js starter which implement graphql module
https://github.com/adrien2p/nestjs-graphql
apollo-server-express dotenv graphql jsonwebtoken jwt nest nest-js node nodejs orm sequelize typescript
Last synced: about 2 months ago
JSON representation
nest-js starter which implement graphql module
- Host: GitHub
- URL: https://github.com/adrien2p/nestjs-graphql
- Owner: adrien2p
- License: mit
- Archived: true
- Created: 2017-08-17T11:28:19.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-20T08:17:46.000Z (almost 6 years ago)
- Last Synced: 2024-08-12T02:01:49.094Z (3 months ago)
- Topics: apollo-server-express, dotenv, graphql, jsonwebtoken, jwt, nest, nest-js, node, nodejs, orm, sequelize, typescript
- Language: TypeScript
- Size: 294 KB
- Stars: 107
- Watchers: 5
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### [UNMAINTAINED]
### Project based on [nest-js-sequelize-jwt](https://github.com/adrien2p/nest-js-sequelize-jwt) and use
- [graphql](http://graphql.org/)
- [graphql-tools](https://github.com/apollographql/graphql-tools)
- [graphql-type-json](https://github.com/taion/graphql-type-json)
- [apollo-server-express](apollo-server-express)
### How it works
- To run lint and fix `npm run lint`
- To run tests suite `npm run test`
- Start the server `npm start`
- To run up/down migration `npm run migrate {up/down}`
### Configuration
To configure put all config file in the `./src/config/*`.
To use the env variable, remove `.demo` from `.env.demo`.
### Request example
#### To get users
`POST http://localhost:3000/graphql` with the following body :
```json
{
"query": "{ getUsers(filter: { search: \"toto\" }) { id, firstName, lastName, email }}"
}
```
Where `getUsers` is a `Query` type which is difine in the `./modules/graphql/config/schema.ts` and implemented in `./modules/graphql/config/resolvers.ts`
And the result of this request is :
```json
{
"data": {
"getUsers": [
{
"id": "1",
"firstName": "firstName",
"lastName": "lastName",
"email": "[email protected]"
}
]
}
}
```
#### To get user with cars
`POST http://localhost:3000/graphql` with the following body :
```json
{
"query": "{ getUsers(filter: { email: \"toto\" }) { id, firstName, lastName, email, cars {id, brandName, purchaseDate }}}"
}
```
Where `getUsers` is a `Query` type which is difine in the `./modules/graphql/config/schema.ts` and implemented in `./modules/graphql/config/resolvers.ts`
and contain `cars` which is also define in `schema` and implemented in `resolver`
And the result of this request is :
```json
{
"data": {
"getUsers": [
{
"id": "1",
"firstName": "firstName",
"lastName": "lastName",
"email": "[email protected]",
"cars": [
{
"id": "1",
"brandName": "tesla",
"purchaseDate": "Thu Aug 17 2017 02:00:00 GMT+0200 (CEST)"
}
]
}
]
}
}
```
#### To update user (is same implementation for all you want)
`POST http://localhost:3000/graphql` with the following body :
```json
{
"query": "mutation {updateUser(values:{ id:1, firstName:\"titi\" }){ id, firstName, lastName, email, cars { id, brandName, purchaseDate }}}"
}
```
The `updateUser` resolver is implemented in the `Mutation` and apply in the `schema`
And the result of this request is :
```json
{
"data": {
"updateUser": {
"id": "1",
"firstName": "titi",
"lastName": "toto",
"email": "[email protected]",
"cars": [
{
"id": "1",
"brandName": "tesla",
"purchaseDate": "Thu Aug 17 2017 02:00:00 GMT+0200 (CEST)"
}
]
}
}
}
```