Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linbudu599/graphql-explorer-server

GraphQL Stack Example: Apollo Server & TypeGraphQL & TypeORM
https://github.com/linbudu599/graphql-explorer-server

apollo-server graphql starter-template typegraphql typeorm typestack

Last synced: 27 days ago
JSON representation

GraphQL Stack Example: Apollo Server & TypeGraphQL & TypeORM

Awesome Lists containing this project

README 

        
# GraphQL-Explorer-Server



![GitHub Workflow Status](https://img.shields.io/github/workflow/status/linbudu599/GraphQL-Explorer-Server/GraphQL-Explorer-Server)

![Codecov](https://img.shields.io/codecov/c/github/linbudu599/GraphQL-Explorer-Server)

![GitHub last commit](https://img.shields.io/github/last-commit/linbudu599/GraphQL-Explorer-Server)

![David](https://img.shields.io/david/dev/linbudu599/GraphQL-Explorer-Server?label=dependencies)



![GitHub package.json dependency version (subfolder of monorepo)](https://img.shields.io/github/package-json/dependency-version/linbudu599/GraphQL-Explorer/graphql)

![GitHub package.json dependency version (subfolder of monorepo)](https://img.shields.io/github/package-json/dependency-version/linbudu599/GraphQL-Explorer/type-graphql)

![GitHub package.json dependency version (subfolder of monorepo)](https://img.shields.io/github/package-json/dependency-version/linbudu599/GraphQL-Explorer/apollo-server)



This is a **demo** which contains `GraphQL` and framework based on it(or work with it perfectly), including these for now:



## 🚀  Explore



```bash

npm install

npm run dev

```



## 🛵  Available Scripts



- `dev`: develop server by [nodemon](https://github.com/remy/nodemon).

- `build`: compile server code by [tsc](https://github.com/microsoft/TypeScript).

  - `prebuild`: Generation of `GenQL` & `Prisma Client`.

  - `postbuild`: copy generated `Prisma Client ` files, run `prisma db push` to create SQLite file.

- `build:vercel`: build scripts on Vercel Functions.

- `start`: run in prod by [nodemon](https://github.com/remy/nodemon)(recommended to run before deployment).

- `clean`: remove `/dist`(build output) & `api-dist`(Vercel build output) directory.

- `test`: run test cases by [Jest](https://github.com/facebook/jest).

- `pm2`: run in prod by [PM2](https://github.com/Unitech/pm2).

- `stress-test`: run pressure test to server, see [stress-fork.js](./st-fork.js) & [stress-main.js](./st-main.js).

- `voyager`: represent GraphQL API as an interactive graph by [GraphQL-Voyager](https://github.com/APIs-guru/graphql-voyager), **require local server to be active**.

- `gen:code`: generate type definitions from GraphQL schema by [GraphQL-Code-Generator](https://github.com/dotansimha/graphql-code-generator).

- `gen:docs`: generate documentation site from GraphQL schema by [GraphDoc](https://github.com/2fd/graphdoc).

- `gen`: generate docs & code, as `gen:code` & `gen:docs` require local server alive, **this command will use NodeJS `child_process` mod to handle server setup.**

- `serve:docs`: generate & serve documentation site by [serve](https://github.com/vercel/serve).

- `commit`: commit code by [custom commitlint config](.cz-config.js).

- `prettier`: prettier all `.ts` / `.json` / `.graphql` ext file.

- `typecheck`: check TypeScript type definitions.

- `seed:config`: check [typeorm-seeding](https://github.com/w3tecch/typeorm-seeding) config.

- `seed:run`: start seeding data in `/server/entity/seeds`.

- `genql`: generate GraphQL query builder by [GenQL](https://github.com/remorses/genql).

- `prisma:*` [Prisma 2](https://www.prisma.io/) Related Commands.



### Main



- [x] GraphQL

- [x] TypeGraphQL

- [x] Apollo-Server

- [x] DataLoader (Supported By [TypeGraphQL-DataLoader](https://github.com/slaypni/type-graphql-dataloader))

- [x] TypeORM + SQLite3

- [x] Prisma 2(As replacement for TypeORM)

- [ ] Subscription



### Other Powerful Tools



- [x] [GraphQLDoc](https://github.com/2fd/graphdoc)

- [x] [GraphQL-Voyager](https://github.com/APIs-guru/graphql-voyager)

- [x] [GenQL](https://github.com/remorses/genql)

- [x] [GraphQL-Code-Generator](https://github.com/dotansimha/graphql-code-generator)



## Features



- [x] TypeORM Entity Relations [Setup](./server/entities): 1-1 1-m m-n

- [x] Most API of TypeGraphQL: InputType / InterfaceType / AuthChecker / Middlewares / Containers / ...

- [x] Configurated Apollo-Server With [Plugins](./server/plugins)

- [x] Visualized API Graph by GraphQLDoc & GraphQL-Voyager

- [x] Useful [Directives](./server/directives) & [Decorators](./server/decorators)



## 🏗️   Server & Docs Deployment



- [x] [Docs by Surge](http://graphql-explorer-docs.surge.sh/)

- [x] [Voyager by Surge](http://graphql-explorer-voyager.surge.sh/) **(Require Local Server To Be Active)**

- [x] [Voyager on Remote Server](http://voyager.linbudu.top/)

- [x] [Simple Example on Vercel Fucntions](https://graphql-faas.vercel.app/api/sample), see [Query Example](./api/sample/query.graphql)

- [x] [Simple Example of Vercel Fucntions, with MySQL](https://graphql-faas.linbudu599.vercel.app/api/graphql)

- [x] [Full Server Deployed at ALI Cloud ECS](http://47.97.183.158:4399/graphql)

- [x] [Apollo Engine(**private**)](https://studio.apollographql.com/graph/My-Graph-innqj/explorer?schemaTag=current)



## 📔  Document



see offcial docs for more information.



- [GraphQL](https://graphql.org/)

- [Apollo-GraphQL](https://www.apollographql.com/docs/)

- [TypeGraphQL](https://typegraphql.com/)

- [TypeStack](https://github.com/typestack)

- [TypeORM](https://github.com/typeorm)

- [Prisma](https://www.prisma.io/)