README.md

THIS IS A WORK IN PROGRESS

This is a work in progress, and is not production ready. Feel free to use it as a base, but it's not production ready by any means.

If you want to see how to connect with this repo (using react) checkout this repo

Prerequiset Knowledge

1. Learn typescript, lynda and egghead.io have great tutorials. Or check the main website.
2. Learn typescripts async/await.
3. Learn GraphQL

Libraries

3. typeorm
4. sinon
5. mocha

Dependencies

1. Node 6
2. Redis

Getting started

1. run npm install

Developing

1. run npm run dev

   This should open a node server on port 8090, and will run the tests and reload any time you make a change.

2. graphiql should be available at here.

3. run npm run test:coverage to run tests that will fail if there isn't enough coverage.

4. run npm run test:watch to re-run the tests whenver a file changes.

Setting up redis7

To make a basic redis configuration change the port and host in the redisConfig (at least for the moment).

Unit tests

1. any file in src/**/*.test.ts run using mocha.

   see npm run test:*

Project structure

src/
├── auth.ts // Passport authenticaion
├── graphql // graphql schemas
│   └── schema.gql // main schema
├── index.ts // graphql and server hookup
├── models // used for typeorm db connection
│   ├── index.ts // Data base connection
│   └── user.ts // User model
└── server.ts // server setup and config

Deploying

1. run npm run build
2. run npm start