nuxtent-template icon indicating copy to clipboard operation
nuxtent-template copied to clipboard

Documentation: Add complete configuration example

Open renestalder opened this issue 6 years ago • 0 comments

What problem does this feature solve?

To this moment, in my understanding, there are two API configuration parameters that are essential for making a successful build: baseURL and browserBaseURL. Also, as I understand it, those parameters mainly come from axios.

The current documentation only contains a browserBaseURL example showing the condition between static and non-static. But in my tests, this mostly isn't enough.

To that point, I couldn't make nuxtent running with local dev server, local nuxt generate and remote nuxt generate at the same time. While I got local nuxt generate and local nuxt server running at some point, struggles begin when trying to do the same in production mode.

The documentation IMHO doesn't show all possibilities, I completely misunderstand how it should work or the module is broken in some way. As I think it's more a problem of the documentation on not a bug, I'm looking for more complete examples for the configuration.

What does the proposed changes look like?

  • Show examples involving baseURL and browserBaseURL.
  • Link to related Axios/Nuxt tutorials for configuration if this not in anyway related to the nuxtent module.
  • Add examples for local development, production deployment and for local and remote static generation. Especially in combination with isStatic and NODE_ENV.

Based on all the issues I've read through, it's not clear enough. I really would like to send a push request for this, but as you see, I struggle myself. So If you don't mind explaining this in more detail so I understand it, I'd love to send in a proposal for more clear documentation.

This feature request is available on Nuxt community (#c15)

renestalder avatar Jul 29 '18 16:07 renestalder