chalkedgoose / famservice

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GraphQL backend server

👩🏻‍💻 Developer Ready: A comprehensive template. Works out of the box for most [Node.js][nodejs] projects.

🏃🏽 Instant Value: All basic tools included and configured:

  • [TypeScript][typescript] [4.0][typescript-4-0]
  • [ESLint][eslint] with some initial rules recommendation
  • [Jest][jest] for fast unit testing and code coverage
  • Type definitions for Node.js and Jest
  • [Prettier][prettier] to enforce consistent code style
  • NPM scripts for common operations
  • Simple example of TypeScript code and unit test
  • .editorconfig for consistent file format
  • Reproducible environments thanks to [Volta][volta]
  • Example configuration for [GitHub Actions][gh-actions] and [Travis CI][travis]

Yoga GraphQL https://github.com/prisma-labs/graphql-yoga

Available Scripts

  • clean - remove coverage data, Jest cache and transpiled files,
  • build - transpile TypeScript to ES6,
  • build:watch - interactive watch mode to automatically transpile source files,
  • lint - lint source files and tests,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests

Additional Informations

Why include Volta

[Volta][volta]’s toolchain always keeps track of where you are, it makes sure the tools you use always respect the settings of the project you’re working on. This means you don’t have to worry about changing the state of your installed software when switching between projects. For example, it's [used by engineers at LinkedIn][volta-tomdale] to standarize tools and have reproducible development environments.

I recommend to [install][volta-getting-started] Volta and use it to manage your project's toolchain.

Writing tests in JavaScript

Writing unit tests in TypeScript can sometimes be troublesome and confusing. Especially when mocking dependencies and using spies.

This is optional, but if you want to learn how to write JavaScript tests for TypeScript modules, read the [corresponding wiki page][wiki-js-tests].

License

Licensed under the APLv2. See the LICENSE file for details.

About

License:Apache License 2.0


Languages

Language:TypeScript 82.6%Language:JavaScript 17.4%