Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.37 KB

README.md

File metadata and controls

83 lines (56 loc) · 3.37 KB

Dublin Coach Backend

CircleCI dependencies Status Code Climate NSP Status

Features:

  • GraphQL Yogo
  • ES2017+ support with Babel.
  • Continuous deployment to Google kubernetes Engine.
  • Testing with Jest.

Testing

Testing is powered by Jest.

Start the test runner in watch mode with:

yarn test

You can also generate coverage with:

yarn test -- --coverage

(the extra double hyphen -- is necessary).

GraphQL Yogo

Fully-featured GraphQL Server with focus on easy setup, performance & great developer experience

Overview

  • Easiest way to run a GraphQL server: Sensible defaults & includes everything you need with minimal setup.
  • Includes Subscriptions: Built-in support for GraphQL subscriptions using WebSockets.
  • Compatible: Works with all GraphQL clients (Apollo, Relay...) and fits seamless in your GraphQL workflow.

graphql-yoga is based on the following libraries & tools:

Features

  • GraphQL spec-compliant
  • File upload
  • GraphQL Subscriptions
  • TypeScript typings
  • GraphQL Playground
  • Extensible via Express middlewares
  • Apollo Tracing
  • Accepts both application/json and application/graphql content-type

Environmental variables in development

The project uses dotenv for setting environmental variables during development. Simply copy .env.example, rename it to .env and add your env vars as you see fit.

It is strongly recommended never to check in your .env file to version control. It should only include environment-specific values such as database passwords or API keys used in development. Your production env variables should be different and be set differently depending on your hosting solution. dotenv is only for development.

Deployment

Deployment is specific to hosting platform/provider but generally:

yarn run build

will compile your src into /build, and

yarn start

will run build (via the prestart hook) and start the compiled application from the /build folder.

License

MIT License. See the LICENSE file.