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: Next.JS Monorepo Guide #13

Merged
merged 4 commits into from
Nov 2, 2024
Merged

Conversation

mohitxskull
Copy link
Contributor

@mohitxskull mohitxskull commented Oct 28, 2024

A page designed to help streamline the process of connecting AdonisJS with a NextJS Frontend using Tuyau in a workspace environment.

Additional:

  • Adding a ./.adonisjs/index.ts file, and reference the adonisrc.ts file there, we'd be able to access type information there, instead of in the frontend files where we import the API schema, this also allows us to reference other types which we gonna need in one place. ( eg: creating a custom vine rule and declaring it. )

@mohitxskull mohitxskull changed the title Next.JS Guide Next.JS Monorepo Guide Oct 28, 2024
@mohitxskull
Copy link
Contributor Author

Heyy @Julien-R44

Rather then putting a monorepo inside a monorepo by creating a ./examples/nextjs wouldn't be better to create a separate repository like you have here.

@Julien-R44
Copy link
Owner

Julien-R44 commented Oct 28, 2024

Thanks a lot for the PR! The docs look clear like that

Creating a separate repository sounds good for me. You could probably host it under your account ? and we'll reference it in the documentation just like that

About the .adonisjs/index.ts file: I’m thinking it might ideally be auto-generated. Then, people could add the missing <references> as they develop. I’ll think about it a bit

package.json Outdated Show resolved Hide resolved
docs/content/docs/next-js.md Outdated Show resolved Hide resolved
docs/content/docs/next-js.md Outdated Show resolved Hide resolved
@mohitxskull
Copy link
Contributor Author

Creating a separate repository sounds good for me. You could probably host it under your account ? and we'll reference it in the documentation just like that

Okay 👍

About the .adonisjs/index.ts file: I’m thinking it might ideally be auto-generated. Then, people could add the missing as they develop. I’ll think about it a bit

Yes, it is definitely better to generate it. If you decide to do that, let me know, and I'll happily write it for you. I literally read all the code in @tuyau/core in order to write my own version of Tuyau with some improvements.

@Julien-R44
Copy link
Owner

Hey !

Yes, it is definitely better to generate it. If you decide to do that, let me know, and I'll happily write it for you

Okay lets do it. Would you like to create the PR to use .adonisjs/index.ts as you suggested ? If you don't have the time, let me know and I'll take care of it.

I literally read all the code in @tuyau/core in order to write my own version of Tuyau with some improvements.

Why not bring these improvements to Tuyau isntead? 😼


Otherwise, current PR looks good to me. Let's merge it. Thanks a lot for taking the time to update the documentation and creating an example

@Julien-R44 Julien-R44 changed the title Next.JS Monorepo Guide docs: Next.JS Monorepo Guide Nov 2, 2024
@Julien-R44 Julien-R44 merged commit 1ad92d4 into Julien-R44:main Nov 2, 2024
3 checks passed
@mohitxskull
Copy link
Contributor Author

Okay lets do it. Would you like to create the PR to use .adonisjs/index.ts as you suggested ? If you don't have the time, let me know and I'll take care of it.

No problem, I'll do it.

Why not bring these improvements to Tuyau instead? 😼

Those changes are more improvements for me because i wanted things to work in a different way and format, so i’m not sure how useful they’ll be for Tuyau in general.

But i am able to share that repo with you so you can see my changes and if you think there’s anything in there that would help, i’ll be happy to put it into Tuyau itself.

Otherwise, current PR looks good to me. Let's merge it. Thanks a lot for taking the time to update the documentation and creating an example

I'm happy to help! Let me know if I can do anything else.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants