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] Expanded the Laravel quickstart with instructions on how to run Vite #4236

Merged
merged 16 commits into from
Oct 1, 2022

Conversation

Ellarddekoeijer
Copy link
Contributor

@Ellarddekoeijer Ellarddekoeijer commented Sep 28, 2022

These changes can be found under the Laravel section in the quickstart for CMSes page.

@rfay
Copy link
Member

rfay commented Sep 28, 2022

Tests problem is just adding the missing things (vite/viteserve I think) to the https://github.com/drud/ddev/blob/master/.spellcheckwordlist.txt

ddev get torenware/ddev-viteserve
```
In `.ddev/.env` change `VITE_PROJECT_DIR=frontend` to `VITE_PROJECT_DIR=.`

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although it is marked as experimental, I think the following is important to add:

In `.ddev/.env` add `VITE_JS_PACKAGE_MGR=npm`. This tells `ddev-viteserve` to use `npm` to manage packages, and 
helps keep dependencies in sync.

Laravel prefers npm which uses the package.lock. See torenware/ddev-viteserve#3

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tyler36 - can you try using the "Suggestion" feature when you know what is the best thing to do? You can just click the icon shown, it makes it so easy for the author of a PR then to just accept and commit your suggestion.

Expanded_the_Laravel_quickstart_with_instructions_on_how_to_run_Vite_by_Ellarddekoeijer_·_Pull_Request__4236_·_drud_ddev

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although it is marked as experimental, I think the following is important to add:

I should probably change the docs; I no longer consider this to be experimental.

In `.ddev/.env` add `VITE_JS_PACKAGE_MGR=npm`. This tells `ddev-viteserve` to use `npm` to manage packages, and 
helps keep dependencies in sync.

Does Laravel itself rely on npm and package.lock? In general, I'd argue pnpm is a better package manager, especially in terms of its speed.

Laravel prefers npm which uses the package.lock. See torenware/ddev-viteserve#3

Does it?

@rfay rfay changed the title Expanded the Laravel quickstart with instructions on how to run Vite [docs] Expanded the Laravel quickstart with instructions on how to run Vite Sep 29, 2022
Co-authored-by: tyler36 <tyler36@users.noreply.github.com>
@tyler36
Copy link
Collaborator

tyler36 commented Sep 29, 2022

@Ellarddekoeijer thanks for adding the guide BTW.

I know it will help alot of Laravel uses. There's been a lot of question lately on Discord too!

@Ellarddekoeijer
Copy link
Contributor Author

@tyler36 thanks for the kind words earlier, I did not see them as I was making changes!

@Ellarddekoeijer
Copy link
Contributor Author

In the future I will see if implementation guides for Vue, Reac, Intertia.js etc are needed or if we can simply link to existing vite implementation guides. Currently I think that the implementation process is identical and no additional steps are required.

@rfay
Copy link
Member

rfay commented Sep 29, 2022

Everybody happy with this?

@rfay
Copy link
Member

rfay commented Sep 29, 2022

@Ellarddekoeijer there are other places to put more extensive guides too, not just the quickstart, so when it looks like we need to do more just let me know. Thanks for your expertise here!

@rfay
Copy link
Member

rfay commented Sep 30, 2022

@mattstein have anything to say about this?

Copy link
Sponsor Collaborator

@mattstein mattstein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do, with apologies in advance to @Ellarddekoeijer for how nitpicky they are! (I’m working on a bunch of edits like this over here 😅 .) Used suggestions for the first time so I hope they’re easy to merge or discuss.

docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved
Ellarddekoeijer and others added 9 commits September 30, 2022 20:12
Co-authored-by: Matt Stein <m@ttste.in>
Co-authored-by: Matt Stein <m@ttste.in>
Co-authored-by: Matt Stein <m@ttste.in>
Co-authored-by: Matt Stein <m@ttste.in>
Co-authored-by: Matt Stein <m@ttste.in>
Co-authored-by: Matt Stein <m@ttste.in>
Co-authored-by: Matt Stein <m@ttste.in>
Co-authored-by: Matt Stein <m@ttste.in>
Co-authored-by: Matt Stein <m@ttste.in>
@rfay rfay merged commit 57d6a44 into ddev:master Oct 1, 2022
@rfay
Copy link
Member

rfay commented Oct 1, 2022

Thanks all!

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.

None yet

5 participants