This is a demo which contains GraphQL
and framework based on it(or work with it perfectly), including these for now:
npm install
npm run dev
dev
: develop server by nodemon.build
: compile server code by tsc.prebuild
: Generation ofGenQL
&Prisma Client
.postbuild
: copy generatedPrisma Client
files, runprisma db push
to create SQLite file.
build:vercel
: build scripts on Vercel Functions.start
: run in prod by nodemon(recommended to run before deployment).clean
: remove/dist
(build output) &api-dist
(Vercel build output) directory.test
: run test cases by Jest.pm2
: run in prod by PM2.stress-test
: run pressure test to server, see stress-fork.js & stress-main.js.voyager
: represent GraphQL API as an interactive graph by GraphQL-Voyager, require local server to be active.gen:code
: generate type definitions from GraphQL schema by GraphQL-Code-Generator.gen:docs
: generate documentation site from GraphQL schema by GraphDoc.gen
: generate docs & code, asgen:code
&gen:docs
require local server alive, this command will use NodeJSchild_process
mod to handle server setup.serve:docs
: generate & serve documentation site by serve.commit
: commit code by custom commitlint config.prettier
: prettier all.ts
/.json
/.graphql
ext file.typecheck
: check TypeScript type definitions.seed:config
: check typeorm-seeding config.seed:run
: start seeding data in/server/entity/seeds
.genql
: generate GraphQL query builder by GenQL.prisma:*
Prisma 2 Related Commands.
- GraphQL
- TypeGraphQL
- Apollo-Server
- DataLoader (Supported By TypeGraphQL-DataLoader)
- TypeORM + SQLite3
- Prisma 2(As replacement for TypeORM)
- Subscription
- TypeORM Entity Relations Setup: 1-1 1-m m-n
- Most API of TypeGraphQL: InputType / InterfaceType / AuthChecker / Middlewares / Containers / ...
- Configurated Apollo-Server With Plugins
- Visualized API Graph by GraphQLDoc & GraphQL-Voyager
- Useful Directives & Decorators
- Docs by Surge
- Voyager by Surge (Require Local Server To Be Active)
- Voyager on Remote Server
- Simple Example on Vercel Fucntions, see Query Example
- Simple Example of Vercel Fucntions, with MySQL
- Full Server Deployed at ALI Cloud ECS
- Apollo Engine(private)
see offcial docs for more information.