Skip to content
This repository was archived by the owner on Oct 2, 2019. It is now read-only.

Commit dd18beb

Browse files
committed
update docs
1 parent e3b9820 commit dd18beb

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,21 @@
77

88
# nodejs-graphql-template
99

10-
Node.js, Koa, GraphQL and TypeScript template project.
11-
Batteries included :raised_hands:
10+
Node.js, Koa, GraphQL and TypeScript template project.
11+
Batteries and opinions included :raised_hands:
1212

1313
## Features
1414

1515
- Docker :whale: configuration for production deployment, development and testing
1616
- GraphQL tools:
17-
- _GraphQL IDL_
18-
- _Apollo Tracing_
17+
1918
- _GraphiQL_
2019
- _GraphQL Voyager_
2120
- _GraphQL Playground_
22-
- [GraphQL Models and Connectors architecture](https://dev-blog.apollodata.com/how-to-build-graphql-servers-87587591ded5) implementation
21+
- _GraphQL IDL_
22+
- _Apollo Tracing_
23+
24+
- Reference [GraphQL Models and Connectors architecture](https://dev-blog.apollodata.com/how-to-build-graphql-servers-87587591ded5) implementation
2325
- CORS middleware
2426
- [12 Factor Configuration](https://12factor.net/config) with `.env`
2527
- Configurable logging
@@ -55,7 +57,7 @@ or
5557
- yarn: `$ yarn start`
5658
- Docker: `$ docker-compose up --build`
5759

58-
Attention windows users: when `Docker for Windows` is not an option, install `yarn` and run `$ yarn && yarn docker-mount` beforehand.
60+
Attention Windows users: when `Docker for Windows` is not an option, install `yarn` and run `$ yarn && yarn docker-mount` beforehand.
5961
## Generate TypeScript types for GraphQL schema
6062

6163
- npm: `$ npm run gql-2-ts`
@@ -87,14 +89,14 @@ Set environment variable `CI` to true to generate coverage reports.
8789
In *nix:
8890

8991
`CI=true npm test`
92+
or
93+
`CI=true yarn test`
9094

9195
In Windows:
9296

9397
`set CI=true&&npm test`
94-
95-
In Docker:
96-
97-
`docker-compose -f docker-compose.test.yml run -e CI=true sut`
98+
or
99+
`set CI=true&&yarn test`
98100

99101
## Build
100102

0 commit comments

Comments
 (0)