-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(templates): Update Vite template readmes (#8284)
- Loading branch information
1 parent
4702ea2
commit db4471d
Showing
2 changed files
with
40 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,34 @@ | ||
# templates/unstable-vite-express | ||
# Welcome to Remix + Vite! | ||
|
||
⚠️ Remix support for Vite is unstable and not recommended for production. | ||
📖 See the [Remix docs](https://remix.run/docs) and the [Remix Vite docs](https://remix.run/docs/en/main/future/vite) for details on supported features. | ||
|
||
📖 See the [Remix Vite docs][remix-vite-docs] for details on supported features. | ||
## Development | ||
|
||
## Setup | ||
Run the Express server with Vite dev middleware: | ||
|
||
```shellscript | ||
npx create-remix@latest --template remix-run/remix/templates/unstable-vite-express | ||
npm run dev | ||
``` | ||
|
||
## Run | ||
## Deployment | ||
|
||
Spin up the Express server as a dev server: | ||
First, build your app for production: | ||
|
||
```shellscript | ||
npm run dev | ||
```sh | ||
npm run build | ||
``` | ||
|
||
Or build your app for production and run it: | ||
Then run the app in production mode: | ||
|
||
```shellscript | ||
npm run build | ||
npm run start | ||
```sh | ||
npm start | ||
``` | ||
|
||
## Customize | ||
Now you'll need to pick a host to deploy it to. | ||
|
||
### DIY | ||
|
||
In this template, we'll use Express but remember that these APIs can be used with _any_ Node-compatible server setup that supports standard middleware. | ||
If you're familiar with deploying Express applications you should be right at home. Just make sure to deploy the output of `npm run build` | ||
|
||
[remix-vite-docs]: https://remix.run/docs/en/main/future/vite | ||
- `build/server` | ||
- `build/client` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,36 @@ | ||
# templates/unstable-vite | ||
# Welcome to Remix + Vite! | ||
|
||
⚠️ Remix support for Vite is unstable and not recommended for production. | ||
📖 See the [Remix docs](https://remix.run/docs) and the [Remix Vite docs](https://remix.run/docs/en/main/future/vite) for details on supported features. | ||
|
||
📖 See the [Remix Vite docs][remix-vite-docs] for details on supported features. | ||
## Development | ||
|
||
## Setup | ||
Run the Vite dev server: | ||
|
||
```shellscript | ||
npx create-remix@latest --template remix-run/remix/templates/unstable-vite | ||
npm run dev | ||
``` | ||
|
||
## Run | ||
## Deployment | ||
|
||
Spin up the Vite dev server: | ||
First, build your app for production: | ||
|
||
```shellscript | ||
npm run dev | ||
```sh | ||
npm run build | ||
``` | ||
|
||
Or build your app for production and run it: | ||
Then run the app in production mode: | ||
|
||
```shellscript | ||
npm run build | ||
npm run start | ||
```sh | ||
npm start | ||
``` | ||
|
||
[remix-vite-docs]: https://remix.run/docs/en/main/future/vite | ||
Now you'll need to pick a host to deploy it to. | ||
|
||
### DIY | ||
|
||
If you're familiar with deploying Node applications, the built-in Remix app server is production-ready. | ||
|
||
Make sure to deploy the output of `npm run build` | ||
|
||
- `build/server` | ||
- `build/client` |