search

eidellev / inertiajs-adonisjs

279 stars 17 forks source link

[doc] Add additional dependencies Inertia depends on. #49

Closed Shigetorum635 closed 2 years ago

Shigetorum635 commented 2 years ago

Sometimes developers switch project structure, and change from REST API to InertiaJS, but the documentation here only explains how to Install InertiaJS standalone.

In the PR I've added some instructions on additional dependencies required to run InertiaJS within AdonisJS. Sadly Adonis and Inertia don't do a good job at catching those type of errors, simply erroring saying the Inertia Module could not be found.

image

This additional documentation could help developers get working with Inertia faster without experiencing these small mistakes that take much time.

eidellev commented 2 years ago

@Shigetorum635 Thank you for your contribution! It's greatly appreciated. One small thing - this project uses commit lint and conventional commits. Please change the commit to something like docs: Add additional dependencies Inertia depends on so that your PR passes the CI pipeline.

Shigetorum635 commented 2 years ago

@eidellev Fixed the commit. Should be good to go now.

eidellev commented 2 years ago

I think the communit message needs to be all lowercase

Shigetorum635 commented 2 years ago

Alright, commit linting is very special lol

Will do when I have time