Skip to content

Commit 5ebc69a

Browse files
author
hirsch88
committed
Add graphql to the readme
1 parent f9c0a2e commit 5ebc69a

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
[Jest](https://facebook.github.io/jest/),
1919
[Swagger](http://swagger.io/),
2020
[validatejs](https://validatejs.org/),
21+
[GraphQL](http://graphql.org/),
22+
[DataLoaders](https://github.com/facebook/dataloader),
2123
by [w3tech](https://github.com/w3tecch)
2224

2325
## Why
@@ -44,6 +46,8 @@ Try it!! We are happy to hear your feedback or any kind of new features.
4446
- **Easy event dispatching** thanks to [event-dispatch](https://github.com/pleerock/event-dispatch).
4547
- **Fast Database Building** with simple migration from [TypeORM](https://github.com/typeorm/typeorm).
4648
- **Easy Data Seeding** with our own factories.
49+
- **GraphQL** provides as a awesome query language for our api [GraphQL](http://graphql.org/).
50+
- **DataLoaders** helps with performance thanks to caching and batching [DataLoaders](https://github.com/facebook/dataloader).
4751

4852
### Comming soon
4953

@@ -128,6 +132,7 @@ All script are defined in the package.json file, but the most important ones are
128132
### Tests
129133

130134
- Run the unit tests using `npm start test` (There is also a vscode task for this called `test`).
135+
- Run the integration tests using `npm start test:integration`.
131136
- Run the e2e tests using `npm start test:e2e` and don't forget to start your application and your [Auth0 Mock Server](https://github.com/hirsch88/auth0-mock-server).
132137

133138
### Running in dev mode
@@ -165,9 +170,11 @@ The swagger and the monitor route can be altered in the `.env` file.
165170
| Route | Description |
166171
| -------------- | ----------- |
167172
| **/api** | Shows us the name, description and the version of the package.json |
173+
| **/graphql** | Route to the graphql editor or your query/mutations requests |
168174
| **/swagger** | This is the Swagger UI with our API documentation |
169175
| **/monitor** | Shows a small monitor page for the server |
170176
| **/api/users** | Example entity endpoint |
177+
| **/api/pets** | Example entity endpoint |
171178

172179
## Project Structure
173180

@@ -187,6 +194,9 @@ The swagger and the monitor route can be altered in the `.env` file.
187194
| **src/api/services/** | Service layer |
188195
| **src/api/subscribers/** | Event subscribers |
189196
| **src/api/validators/** | Custom validators, which can be used in the request classes |
197+
| **src/api/queries/** | GraphQL queries |
198+
| **src/api/mutations/** | GraphQL mutations |
199+
| **src/api/types/** | GraphQL types |
190200
| **src/api/** swagger.json | Swagger documentation |
191201
| **src/auth/** | Authentication checkers and services |
192202
| **src/core/** | The core features like logger and env variables |
@@ -199,8 +209,10 @@ The swagger and the monitor route can be altered in the `.env` file.
199209
| **src/types/** *.d.ts | Custom type definitions and files that aren't on DefinitelyTyped |
200210
| **test** | Tests |
201211
| **test/e2e/** *.test.ts | End-2-End tests (like e2e) |
212+
| **test/integration/** *.test.ts | Integration test with SQLite3 |
202213
| **test/unit/** *.test.ts | Unit tests |
203214
| .env.example | Environment configurations |
215+
| .env.test | Test environment configurations |
204216
| ormconfig.json | TypeORM configuration for the database. Used by seeds and the migration. (generated file) |
205217

206218
## Logging
@@ -378,6 +390,9 @@ npm start db.seed
378390
| [Auth0 API Documentation](https://auth0.com/docs/api/management/v2) | Authentification service |
379391
| [Jest](http://facebook.github.io/jest/) | Delightful JavaScript Testing Library for unit and e2e tests |
380392
| [swagger Documentation](http://swagger.io/) | API Tool to describe and document your api. |
393+
| [SQLite Documentation](https://www.sitepoint.com/getting-started-sqlite3-basic-commands/) | Getting Started with SQLite3 – Basic Commands. |
394+
| [GraphQL Documentation](http://graphql.org/graphql-js/) | A query language for your API. |
395+
| [DataLoader Documentation](https://github.com/facebook/dataloader) | DataLoader is a generic utility to be used as part of your application's data fetching layer to provide a consistent API over various backends and reduce requests to those backends via batching and caching. |
381396
382397
## Related Projects
383398

0 commit comments

Comments
 (0)