MichalLytek / type-graphql

Create GraphQL schema and resolvers with TypeScript, using classes and decorators!
https://typegraphql.com
MIT License
7.98k stars 674 forks source link

docs(sample): add guide for integrating with azure functions #1637

Closed Mingyang-Li closed 1 month ago

Mingyang-Li commented 4 months ago

Hi, I noticed we don't have any guides on how to integrate this library with Azure Functions, so I wrote a Medium article about it.

This PR involves adding a new page on the documentation website (v2.0.0-beta.6), plus a link to my article on how we can implement the integration, hopefully this will help more people

Update (2024-02-27)

  1. Added a compact guide for integrating with azure functions
  2. Added example project for No.1
carlocorradini commented 4 months ago

@Mingyang-Li Can you add an example in the examples directory? Thanks 👍🙏

MichalLytek commented 4 months ago

I don't see any point of advertising medium article in the project docs.

It would make much more sense to copy/compact the article and add it as a proper doc page here (and maybe also add example as @carlocorradini said).

Doc section with link to article is just like typing "TypeGraphQL Azure Functions" in Google.

MichalLytek commented 2 months ago

@Mingyang-Li I had to remove the example as it's only about config related to all Azure functions + index file, so docs should be sufficient for integrating TypeGraphQL by users. The example was using own package.json + a build step, so it's not easy to run as our other examples.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.50%. Comparing base (be33fd4) to head (a1758b2). Report is 26 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1637 +/- ## ======================================= Coverage 95.50% 95.50% ======================================= Files 113 113 Lines 1847 1847 Branches 364 351 -13 ======================================= Hits 1764 1764 Misses 83 83 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.