alea12/typeorm-apollo-server-boilerplate

GraphQL (TypeORM + Apollo) BFF Boilerplate

Stack

Name	Usage	Possible Alternatives
MySQL	Database	Depends on ORM
TypeORM	ORM	Prisma
Apollo Server	GraphQL Server	GraphQL Helix
Express	HTTP Server	Fastify
ts-node-dev	TypeScript Executor
GraphQL Code Generator	GraphQL => TS Type Generater

Requirements

Software

Software	Tested Version	Link
Node.js	14.17.5	- Installing Node.js via package manager
Yarn	1.22.11	- Installation
Docker	20.10.7	- Install Docker Desktop on Mac - Install Docker Desktop on Windows

Ports

These ports must be vacant and accessible from the docker host machine:

Port #	Usage
13000	API Endpoint (Express Server)
13306	MySQL

Developing

Launching dev server

From your host machine:

yarn install
yarn dev # or: docker compose up

...and access http://localhost:13000/graphql from your host machine.

Database Migration

From your host machine (docker process must be up before operation):

yarn migration:generate -n MIGRATION_NAME_HERE
yarn migration:run

Adding Dependencies

From your host machine (docker process must be shut down before operation):

# this is an example. express is already installed in this project
yarn add express
yarn add -D @types/express

Access to DB

From your host machine (docker process must be up before operation):

mysql -h127.0.0.1 -P13306 -u'typeorm-apollo-server' -p'typeorm-apollo-server' typeorm-apollo-server

In connection URL syntax:

mysql://typeorm-apollo-server:typeorm-apollo-server@127.0.0.1:13306/typeorm-apollo-server