TypeScript GraphQL Server Kit

🚀 Bootstrap your GraphQL server within seconds.

What's inside?

• TypeORM - an ORM that can be used with TypeScript and JavaScript (ES5, ES6, ES7).
• GraphQL - A query language for your API
• GraphQLYoga - Scalable GraphQL server
• GraphQL Playground - GraphQL IDE for better development workflows
• Nodemon - a CLI utility that wraps your Node app, watches the file system for changes and automatically restarts the process.
• TSLint - An extensible linter for the TypeScript language.

Requirements

Make sure your machine has installed following dependencies:

• Node.js
• YARN
• Postgress Mac user can install postgress using Brew Package Manager, using the following commands:

  brew install postgresql        #Installs postgress
  brew services start postgresql #Starts postgress service
  brew services stop postgresql  #Stops postgress service

Installation

Clone the repository

$ git clone -b master [email protected]:code2gether/typescript-graphql-kit.git
# or if you want to rename the project directory name
$ [email protected]:code2gether/typescript-graphql-kit.git <project-name>

Steps to run this project:

1. Resolve required dependencies.

   # Go to the `project` directory
   # Install node dependencies.
   
   $ yarn

2. Setup database settings inside ormconfig.json file

   {
   "port"    : "DB_PORT",
   "username": "DB_USERNAME",
   "password": "DB_PASSWORD",
   "database": "DB_NAME",
   }

3. Run yarn start command and start developing.