Skip to content

Commit cb1e9fa

Browse files
committed
Update the README since the vcpkg port was merged and I added samples
1 parent 1d00480 commit cb1e9fa

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
But GraphQL services are only implemented on the server. When using React Native or React JS in a hybrid application, you typically have a native application which hosts islands or entire pages of UI rendered with React components, and you might like to display content that you've cached offline or that you otherwise generate on the client without needing to declare a separate data interface or require a server round trip to load it.
66

7-
This project includes a `graphqlservice` library with the core functionality of a GraphQL service and a `schemagen` utility to generate types for your custom GraphQL service schema definition. Once you implement the pure virtual methods on the object interfaces and add hooks to the React Environment/Network to call your service, you can use the same GraphQL client code (e.g. Relay) to access your native data source or a GraphQL service online. You might even be able to share some more of that code between a progressive web app and your native app.
7+
This project includes a `graphqlservice` library with the core functionality of a GraphQL service and a `schemagen` utility to generate types for your custom GraphQL service schema definition. Once you implement the pure virtual methods on the object interfaces and add hooks to the Relay Environment/Network to call your service, you can use the same GraphQL client code to access your native data source or a GraphQL service online. You might even be able to share some more of that code between a progressive web app and your native app.
88

99
# Getting Started
1010

@@ -24,7 +24,7 @@ You'll need to have all 3 projects installed on your system along with CMake to
2424

2525
Vcpkg can install the dependencies from source on either platform, and that's what I'm using on Windows. The Windows [installation instructions](https://github.com/Microsoft/vcpkg/blob/master/README.md) for [cpprestsdk](https://github.com/Microsoft/cpprestsdk) recommend it, and if you add the port I did for [graphqlparser](https://github.com/Microsoft/vcpkg/pull/3953) you can get both of them with this tool.
2626

27-
This approach works well on Linux as well, but you'll still need that pull request to add graphqlparser to the ports collection.
27+
This approach works well on Linux as well, graphqlparser has been merged into the ports collection.
2828

2929
### Windows
3030

@@ -40,7 +40,9 @@ Follow the Linux [installation instructions](https://github.com/Microsoft/cppres
4040

4141
## API references
4242

43-
See [GraphQLService.h](GraphQLService.h) for the base types implemented in the `facebook::graphql::service` namespace. Take a look at [Today.h](Today.h) and [Today.cpp](Today.cpp) to see a sample implementation of a custom schema defined in [schema.today.graphql](schema.today.graphql) for testing purposes. The unit tests.
43+
See [GraphQLService.h](GraphQLService.h) for the base types implemented in the `facebook::graphql::service` namespace. Take a look at [Today.h](Today.h) and [Today.cpp](Today.cpp) to see a sample implementation of a custom schema defined in [schema.today.graphql](schema.today.graphql) for testing purposes.
44+
45+
All of the generated files are in the [samples](samples/) directory. If you modify the code generator in SchemaGenerator.* and rebuild, `make install` will update them. Please remember to include updating the samples in any pull requests which change them.
4446

4547
# Build and Test
4648

0 commit comments

Comments
 (0)