Skip to content

Commit 6784f1e

Browse files
committed
Update README.md
1 parent c78e5a5 commit 6784f1e

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

Diff for: README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,34 @@
11
# GraphQL-Modules seed
2-
### Introduction
2+
3+
## Introduction
34

45
This repository is a seed to start [GraphQL-Modules](https://graphql-modules.com/) projects.
56

67
It includes a couple of modules which depend on each other, but in the future I will expand it to include an User module and an Authentication module as well.
78

89
----
910

10-
## Includes:
11-
* GraphQL-Modules
12-
* GraphQL-Code-Generator
13-
* Apollo-Server
14-
* Typescript
11+
### Includes
12+
13+
* [GraphQL-Modules](https://graphql-modules.com/)
14+
* [GraphQL-Code-Generator](https://github.com/dotansimha/graphql-code-generator)
15+
* [Apollo-Server](https://www.apollographql.com/docs/apollo-server/)
16+
* [Typescript](https://www.typescriptlang.org/)
1517

1618
## Installation
19+
1720
To get started locally, follow these instructions:
1821

1922
1. Clone to your local computer using `git`.
20-
1. Make sure that you have Node installed. See instructions [here](https://nodejs.org/en/download/).
23+
1. Make sure that you have Node installed; see instructions [here](https://nodejs.org/en/download/).
2124
1. Make sure that you have `yarn` installed; see instructions [here](https://yarnpkg.com/lang/en/docs/install/).
2225
1. Run `yarn` (no arguments) from the root of your clone of this project.
2326

2427
## Running the seed
28+
2529
To run the seed, follow these instructions:
2630

2731
1. `yarn generate`. This will Generate server-side TypeScript types.
2832
1. `yarn start`. This will use ts-node to compile and run the project.
2933

30-
If you want it to automatically restart the application when changes in the directory are detected, you can use `yarn dev` instead (it's backed by nodemon).
34+
If you want it to automatically restart the application when changes in the directory are detected, you can use `yarn dev` instead (it's backed by nodemon).

0 commit comments

Comments
 (0)