search

solidjs / solid-router

A universal router for Solid inspired by Ember and React Router
MIT License
1.13k stars 143 forks source link

Adding deployment guidelines to the readme. #269

Closed bramdoppen closed 1 year ago

bramdoppen commented 1 year ago

When deploying my Solid.js client-side rendered app to Vercel, the routing didn't work. There was nothing clear specified in the readme. Scrolling through the issues I found this post and looking at it, it's obvious that you would need something like this to work on Vercel.

Would it be an idea to provide a small guideline for the popular platforms (Vercel, Netlify, AWS, etc) with tips like these?

{
  "rewrites": [
    {
      "source": "/(.*)",
      "destination": "/index.html"
    }
  ]
}

Originally posted by @tbdsux in https://github.com/solidjs/solid-router/issues/63#issuecomment-999696986

ryansolid commented 1 year ago

Probably, I haven't seen this in other router docs, probably because it is specific to each platform. But maybe a section where we mention it is needed in deployed environments and then give like a Netlify and Vercel example would be sufficient.