You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+80-35Lines changed: 80 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,10 @@ easily generate a GraphQL API from your sequelize models.
5
5
6
6
It's a very good fit for POCs and MVPs, while also scaling pretty well thanks to [dataloader-sequelize](https://github.com/mickhansen/dataloader-sequelize).
7
7
8
-
## Manual
8
+
---
9
9
10
-
Get started with **[the online documentation](https://teamstarter.github.io/gsg-documentation/)**
10
+
## Documentation
11
+
The complete documentation car be found [here](https://teamstarter.github.io/gsg-documentation/)
11
12
12
13
## What can I do with GSG?
13
14
@@ -23,54 +24,98 @@ The tools provided by this library will allow you to:
23
24
- Add custom fields/resolvers on auto-generated types.
24
25
- Easy integration with [dataloader-sequelize](https://github.com/mickhansen/dataloader-sequelize)
25
26
27
+
---
28
+
26
29
## Getting started
27
30
28
-
Add the lib and the peer dependencies:
31
+
---
32
+
33
+
### Setting up the dependencies and the library
34
+
35
+
Add the lib and the peer dependencies of GraphQL-Sequelize-Generator:
⚠️ Caution: GSG requires at least Node v9.11.2 or greater as it is using async/await.
41
+
⚠️ Caution: GSG requires Node v9.11.2 or greater as it is using async/await.
42
+
43
+
---
44
+
45
+
### Initializing the project with Sequelize-CLI and adding data to the database
35
46
36
-
Then you will be ready to add a GraphQL API to your express server with only a few lines of code:
47
+
If you need to initialize the project, please follow this Sequelize documentation page : [Sequelize-Cli and Migrations](https://sequelize.org/docs/v6/other-topics/migrations/)
48
+
49
+
---
50
+
51
+
# Setting up your server
52
+
53
+
Create a file where you will set up your server and paste the following code. We used index.js (at the root of our example project):
0 commit comments