Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poad/remix-example
https://github.com/poad/remix-example
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/poad/remix-example
- Owner: poad
- License: unlicense
- Created: 2024-04-12T23:54:39.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T12:22:53.000Z (2 months ago)
- Last Synced: 2024-10-29T14:50:51.447Z (2 months ago)
- Language: JavaScript
- Size: 1.89 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# templates/spa
This template leverages [Remix SPA Mode](https://remix.run/docs/en/main/future/spa-mode) and the [Remix Vite Plugin](https://remix.run/docs/en/main/future/vite) to build your app as a Single-Page Application using [Client Data](https://remix.run/docs/en/main/guides/client-data) for all of your data loads and mutations.
## Setup
```shellscript
npx create-remix@latest --template remix-run/remix/templates/spa
```
## Development
You can develop your SPA app just like you would a normal Remix app, via:
```shellscript
npm run dev
```
## Production
When you are ready to build a production version of your app, `npm run build` will generate your assets and an `index.html` for the SPA.
```shellscript
npm run build
```
### Preview
You can preview the build locally with [vite preview](https://vitejs.dev/guide/cli#vite-preview) to serve all routes via the single `index.html` file:
```shellscript
npm run preview
```
> [!IMPORTANT]
>
> `vite preview` is not designed for use as a production server
### Deployment
You can then serve your app from any HTTP server of your choosing. The server should be configured to serve multiple paths from a single root `/index.html` file (commonly called "SPA fallback"). Other steps may be required if the server doesn't directly support this functionality.
For a simple example, you could use [sirv-cli](https://www.npmjs.com/package/sirv-cli):
```shellscript
npx sirv-cli build/client/ --single
```