Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(start/quickstart): add future Vite compatibility #9667

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+11 −10
Open

docs(start/quickstart): add future Vite compatibility #9667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0f362ec
Update quickstart.md for future vite compatibility
ezekeal Jun 27, 2024
908bf6b
Update quickstart.md for future vite compatibility
ezekeal Jun 27, 2024
7b42609
Merge branch 'main' into patch-1
ezekeal Jul 1, 2024
5bef794
Merge branch 'main' into patch-1
ezekeal Jul 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions contributors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@
- evanwinter
- everdimension
- exegeteio
- ezekeal
- F3n67u
- FAL-coffee
- fayez-nazzal
Expand Down
20 changes: 10 additions & 10 deletions docs/start/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,16 @@ export default function App() {

## Build and Run

First build the app for production:
First you will need to specify the type as `module` in `package.json` to satisfy esmodule requirements for `remix-run` and future versions of `vite`.

```jsonc filename=package.json lines=[2] nocopy
{
"type": "module"
// ...
}
```

Next build the app for production:

```shellscript nonumber
npx remix vite:build
Expand All @@ -99,15 +108,6 @@ You should now see a `build` folder containing a `server` folder (the server ver

👉 **Run the app with `remix-serve`**

First you will need to specify the type in `package.json` as module so that `remix-serve` can run your app.

```jsonc filename=package.json lines=[2] nocopy
{
"type": "module"
// ...
}
```

Now you can run your app with `remix-serve`:

```shellscript nonumber
Expand Down