/ts-graphql-api

An example backend API using TypeGraphQL library.

Primary LanguageTypeScriptMIT LicenseMIT

TypeGraphQL Backend API

An example backend API using TypeGraphQL library.

It's a GraphQL API in Node.js with TypeScript. In this demo app I explore how TypeGraphQL addresses the issue of reduntant code often associated with this tech stack. It does this by allowing a developer to define their API using classes and decorators.

Getting started

Getting the server to run locally is as simple as cloning the repo, installing dependenices, and running npm run start:dev. This will spin up a GraphQL Playground environment with hot reloading.

git clone https://github.com/wurde/ts-graphql-api
cd ts-graphql-api
npm install
npm run start:dev
// Open up http://localhost:4000/graphql

Apollo Server

For a GraphQL server I use Apollo. This allows passing in an executable schema, which combines both type definitions and resolvers.

SQLite with TypeORM

I use SQLite as a local data store and TypeORM for object-relational mapping (ORM).

References