Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Improvement: Framework Integration #17

Open
seangwright opened this issue Sep 29, 2022 · 2 comments
Open

Docs Improvement: Framework Integration #17

seangwright opened this issue Sep 29, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@seangwright
Copy link
Owner

Is your feature request related to a problem? Please describe.
It can be difficult to know which APIs of the monads in this library should be used in a given situation - specifically when using a framework that has an opinionated perspective on how to structure things and pass data around.

Describe the solution you'd like
We can create small guides (linked from the README.md) that show how someone might use the library with a framework (backend and frontend) with a small snippet of example code and some principles to follow.

We could begin with a handful of framework examples, choosing the most popular as a starting point.

Here are some options:

  • Backend

    • Nestjs
    • Fastify
    • Nextjs
    • Remix
  • Frontend

    • Svelte
    • Vue
    • Angular
    • React
    • AlpineJS
    • Vanilla JS

Describe alternatives you've considered
We could write blog posts to cover this but the README.md currently links out to blog posts that discuss how Maybe and Result can be used.
We already have a full suite of unit tests and those should be independent of a framework anyway, so none of these improvements belong there.

Additional context
See: Issue #14

@seangwright seangwright added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Sep 29, 2022
@xShivan
Copy link

xShivan commented Jan 26, 2023

Hi. Here's a little integration we wrote in Startup Development House: https://www.npmjs.com/package/@startupdevhouse/typescript-functional-extensions-nestjs

You might want to reference it somewhere in README.md. Enjoy! 😄

@seangwright
Copy link
Owner Author

@xShivan awesome! I'll add a link in #18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants