From your terminal:
npm run devThis starts your app in development mode, rebuilding assets on file changes.
First, build your app for production:
npm run buildThen run the app in production mode:
npm startNow you'll need to pick a host to deploy it to.
If you're familiar with deploying node applications, the built-in Remix app server is production-ready.
Make sure to deploy the output of remix build
build/public/build/
When you ran npx create-remix@latest there were a few choices for hosting. You can run that again to create a new project, then copy over your app/ folder to the new project that's pre-configured for your target server.
cd ..
# create a new project, and pick a pre-configured host
npx create-remix@latest
cd my-new-remix-app
# remove the new project's app (not the old one!)
rm -rf app
# copy your app over
cp -R ../my-old-remix-app/app appThis repo has been modified from a bare bones Remix template to add static site generation capabilities.
To build your site statically, first do a normal build and boot the production server as shown above.
Then, in a separate terminal tab do:
npm run build-staticThis will generate a static directory with the HTML files and assets you need to serve a fully hydrated Remix site. It uses wget to pull HTML, CSS, and JS from the server you have running in the other tab. It pulls all the URLs listed in static-urls.txt. Once it completes, you can shut down the local server.
To test out your static build, run:
npm run serve-staticTo deploy, just copy the static dir to your static hosting provider.
IMPORTANT
This isn't typically how Remix works (we usually have a server) so you'll want to note a few things about this setup:
loaderstill works (seeapp/routes/one.tsxandapp/routes/two.tsx) so you can still grab data from the filesystem or from your database and put it into your markup viauseLoaderData- Although the page is fully hydrated with React on it (we are still rendering the
<Scripts>element inapp/root.tsx) all navigation on the site should be done with a full document reload (using<Link reloadDocument>). This is because no server is running to be able to dynamically serve the data we need for the new route when we do a client-side transition to it. However, the data is already encoded in the HTML in thestaticoutput directory we generated in thebuild-staticcommand. - Other features that require a server (like
action) will not work.